mgmt_console 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dca067a993c809cca112d79708e1c279d561f0d0
+  data.tar.gz: ef3a9c6f8435408c168a388fb30e21d34d4cd5de
+SHA512:
+  metadata.gz: 752ebdf19527041a430dc51c0349f9545a4a6141db32476539e396136bdc191edb9a3ac06b96b69d83b6f5b92db8a1336ffb722f7badfd323d73e374d9ec062f
+  data.tar.gz: 55e483833999086fbe4c571e8c85f006b30c939823858cdf13157a06368f70dcce2fb354509003986f3876317a1ee2e4e241c6fd342957e347e8e8f822d780bb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mgmt_console.gemspec
+gemspec

data/README.md

@@ -0,0 +1,46 @@
+# MgmtConsole
+
+This is an API client gem for our [mgmt console][1].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mgmt_console'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mgmt_console
+
+## Usage
+
+The example below is how to retrieve a list of all communities across all instances.
+
+    require 'mgmt_console'
+    client = MgmtConsole::Client.new(access_token: '7fd3e655e79037d66b7b2cd4094c13b4', api_endpoint: 'https://console.mindjet.com/api/v1', ssl_verify: true)
+    engage_communities = client.engage_communities(nil, per_page: 200)
+    while client.last_response.rels[:next]
+      engage_communities.concat(client.last_response.rels[:next].get.data)
+    end
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to 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 it ( https://github.com/[my-github-username]/mgmt_console/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[1]: https://console.mindjet.com/

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mgmt_console"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/query_engage_.md

@@ -0,0 +1,8 @@
+How to query for engage communities
+
+    require 'mgmt_console'
+    client = MgmtConsole::Client.new(access_token: '7fd3e655e79037d66b7b2cd4094c13b4', api_endpoint: 'https://console.dev.com/api/v1', ssl_verify: false)
+    engage_communities = client.engage_communities(nil, per_page: 200)
+    while client.last_response.rels[:next]
+      engage_communities.concat(client.last_response.rels[:next].get.data)
+    end

data/lib/mgmt_console/api_error.rb

@@ -0,0 +1,4 @@
+module MgmtConsole
+  class ApiError < StandardError
+  end
+end

data/lib/mgmt_console/authentication.rb

@@ -0,0 +1,23 @@
+module MgmtConsole
+
+  # Authentication methods for {MgmtConsole::Client}
+  module Authentication
+
+    # Indicates if the client was supplied an OAuth
+    # access token
+    #
+    # @see https://developer.github.com/v3/#authentication
+    # @return [Boolean]
+    def token_authenticated?
+      !!@access_token
+    end
+
+    # Indicates if the client was supplied an access token
+    #
+    # @return [Boolean]
+    def user_authenticated?
+      token_authenticated?
+    end
+
+  end
+end

data/lib/mgmt_console/client/engage_communities.rb

@@ -0,0 +1,50 @@
+module MgmtConsole
+  class Client
+
+    # Methods for the Engage Communities API
+    module EngageCommunities
+
+      # Get Engage Communities list
+      #
+      # @return [Array<Sawyer::Resource>] Array of engage communities
+      # @example Get Engage Communities
+      #   @client.engage_communities
+      def engage_communities(options = {})
+        engage_instance_id = options.delete(:engage_instance_id)
+
+        if engage_instance_id.nil?
+          paginate("#{api_endpoint}/engage_communities", options)
+        else
+          paginate("#{api_endpoint}/engage_instances/#{engage_instance_id}/engage_communities", options)
+        end
+      end
+
+      # Create Engage Communities
+      #
+      # @return [Array<Sawyer::Resource>] Array of engage communities
+      # @example Get Engage Communities
+      #   @client.update_engage_communities(engage_instance_id: 'df40ec3e-4ad3-4abf-b7c9-c306721f91ea',
+      #                                     engage_communities: [{siteid: 1, servername: 'www1.cust.spigit.com', port: 443},
+      #                                                          {siteid: 2, servername: 'www2.cust.spigit.com', port: 443}],
+      #                                     action: 'replace')
+      def create_engage_communities(options = {})
+        # Required
+        engage_instance_id = options.delete(:engage_instance_id)
+        engage_communities = options.delete(:engage_communities)
+
+        raise MgmtConsole::BadRequest.new('You must provide the Engage Instance ID as :engage_instance_id') unless engage_instance_id
+        raise MgmtConsole::BadRequest.new('You must provide the Engage Communities as :engage_communities') unless engage_communities
+
+        # Optional
+        action = options.delete(:action)
+
+        params = {
+          engage_communities: engage_communities,
+          action: action,
+        }.reject { |k,v| v.nil? }
+
+        data = post("#{api_endpoint}/engage_instances/#{engage_instance_id}/engage_communities", options.merge(params))
+      end
+    end
+  end
+end

data/lib/mgmt_console/client/engage_environments.rb

@@ -0,0 +1,46 @@
+module MgmtConsole
+  class Client
+
+    # Methods for the EngageEnvironmentsAPI
+    module EngageEnvironments
+
+      # Get Engage Environments list
+      #
+      # @return [Array<Sawyer::Resource>] Array of engage environments
+      # @example Get engage environments
+      #   @client.engage_environments
+      def engage_environments(options = {})
+        data = get("#{api_endpoint}/engage_environments", options)
+      end
+
+      # Create Engage Environment
+      #
+      # @return [Sawyer::Resource] Engage Environment
+      # @example Create engage environment
+      #   @client.create_engage_environment()
+      def create_engage_environment(name=nil, options = {})
+        params = { :name => name }
+        data = post("#{api_endpoint}/engage_environments", options.merge(params))
+      end
+
+      # Update Engage Environment
+      #
+      # @param id [String] Engage Environment ID
+      # @return [Sawyer::Resource] Engage Environment
+      # @example Update engage environment
+      #   @client.update_engage_environment('47d80252-f65e-41bb-b589-7833a1fdd623', only_allow_one_per_cluster: true)
+      def update_engage_environment(id=nil, options = {})
+        raise MgmtConsole::BadRequest.new('You must provide the Engage Environment ID as the first paramater') unless id
+
+        # Optional
+        only_allow_one_per_cluster = options.delete(:only_allow_one_per_cluster)
+
+        params = {
+          only_allow_one_per_cluster: only_allow_one_per_cluster,
+        }.reject { |k,v| v.nil? }
+
+        data = patch("#{api_endpoint}/engage_environments/#{id}", options.merge(params))
+      end
+    end
+  end
+end

data/lib/mgmt_console/client/engage_instances.rb

@@ -0,0 +1,77 @@
+module MgmtConsole
+  class Client
+
+    # Methods for the EngageInstances API
+    module EngageInstances
+
+      # Get Engage Instances list
+      #
+      # @return [Array<Sawyer::Resource>] Array of engage instances
+      # @example Get engage instances
+      #   @client.engage_instances
+      def engage_instances(options = {})
+        paginate("#{api_endpoint}/engage_instances", options)
+      end
+
+      # Create Engage Instance
+      #
+      # @return [Sawyer::Resource] Engage Instance
+      # @example Create engage instance
+      #   @client.create_engage_instance(dbname: 'abc123', engage_server_id: 'b4c2719c-10ac-487c-9af4-59c297e17766', branch: '3-6-0-stable')
+      def create_engage_instance(options = {})
+        # Required
+        dbname = options.delete(:dbname)
+        engage_server_id = options.delete(:engage_server_id)
+
+        raise MgmtConsole::BadRequest.new('You must provide the Engage Instance Database name as :dbname') unless dbname
+        raise MgmtConsole::BadRequest.new('You must provide the Engage Server ID as :engage_server_id')     unless engage_server_id
+
+        # Optional
+        salesforce_uid = options.delete(:salesforce_uid)
+        branch = options.delete(:branch)
+        commit = options.delete(:commit)
+        engage_environment_id = options.delete(:engage_environment_id)
+
+        params = {
+          dbname: dbname,
+          engage_server_id: engage_server_id,
+          salesforce_uid: salesforce_uid,
+          branch: branch,
+          commit: commit,
+          engage_environment_id: engage_environment_id,
+        }.reject { |k,v| v.nil? }
+
+        data = post("#{api_endpoint}/engage_instances", options.merge(params))
+      end
+
+      # Update Engage Instance
+      #
+      # @return [Sawyer::Resource] Engage Instance
+      # @example Update engage instance
+      #   @client.update_engage_instance('bae956a6-17c9-4d65-b786-1c3aae311fb2', branch: '3-5-8-stable', commit: '7a0c870')
+      def update_engage_instance(id=nil, options = {})
+        # Required
+        raise MgmtConsole::BadRequest.new('You must provide the Engage Instance ID as :id') unless id
+
+        # Optional
+        dbname = options.delete(:dbname)
+        engage_server_id = options.delete(:engage_server_id)
+        salesforce_uid = options.delete(:salesforce_uid)
+        branch = options.delete(:branch)
+        commit = options.delete(:commit)
+        engage_environment_id = options.delete(:engage_environment_id)
+
+        params = {
+          dbname: dbname,
+          engage_server_id: engage_server_id,
+          salesforce_uid: salesforce_uid,
+          branch: branch,
+          commit: commit,
+          engage_environment_id: engage_environment_id,
+        }.reject { |k,v| v.nil? }
+
+        data = patch("#{api_endpoint}/engage_instances/#{id}", options.merge(params))
+      end
+    end
+  end
+end

data/lib/mgmt_console/client/engage_servers.rb

@@ -0,0 +1,58 @@
+module MgmtConsole
+  class Client
+
+    # Methods for the EngageServers API
+    module EngageServers
+
+      # Get Engage Servers list
+      #
+      # @return [Array<Sawyer::Resource>] Array of engage servers
+      # @example Get engage servers
+      #   @client.engage_servers
+      def engage_servers(options = {})
+        data = get("#{api_endpoint}/engage_servers", options)
+      end
+
+      # Create Engage Server
+      #
+      # @param hostname [String] Engage Server hostname
+      # @return [Sawyer::Resource] Engage Server
+      # @example Create engage server
+      #   @client.create_engage_server('r225.spigit.com')
+      def create_engage_server(hostname=nil, options = {})
+        raise MgmtConsole::BadRequest.new('You must provide the Engage Server hostname as the first paramater') unless hostname
+
+        # Optional
+        timezone = options.delete(:timezone)
+
+        params = {
+          :hostname => hostname,
+          :timezone => timezone
+        }.reject { |k,v| v.nil? }
+
+        data = post("#{api_endpoint}/engage_servers", options.merge(params))
+      end
+
+      # Update Engage Server
+      #
+      # @param id [String] Engage Server ID
+      # @return [Sawyer::Resource] Engage Server
+      # @example Update engage server
+      #   @client.update_engage_server('47d80252-f65e-41bb-b589-7833a1fdd623', server_environment_id: '7ab127a6-1d80-477f-b349-08bfc7e757ac')
+      def update_engage_server(id=nil, options = {})
+        raise MgmtConsole::BadRequest.new('You must provide the Engage Server ID as the first paramater') unless id
+
+        # Optional
+        server_environment_id = options.delete(:server_environment_id)
+        timezone              = options.delete(:timezone)
+
+        params = {
+          server_environment_id: server_environment_id,
+          timezone: timezone,
+        }.reject { |k,v| v.nil? }
+
+        data = patch("#{api_endpoint}/engage_servers/#{id}", options.merge(params))
+      end
+    end
+  end
+end

data/lib/mgmt_console/client/server_environments.rb

@@ -0,0 +1,27 @@
+module MgmtConsole
+  class Client
+
+    # Methods for the ServerEnvironmentsAPI
+    module ServerEnvironments
+
+      # Get Server Environments list
+      #
+      # @return [Array<Sawyer::Resource>] Array of server environments
+      # @example Get server environments
+      #   @client.server_environments
+      def server_environments(options = {})
+        data = get("#{api_endpoint}/server_environments", options)
+      end
+
+      # Create Server Environment
+      #
+      # @return [Sawyer::Resource] Server Environment
+      # @example Create server environment
+      #   @client.create_server_environment()
+      def create_server_environment(name=nil, options = {})
+        params = { :name => name }
+        data = post("#{api_endpoint}/server_environments", options.merge(params))
+      end
+    end
+  end
+end

data/lib/mgmt_console/client/spigit_configs.rb

@@ -0,0 +1,65 @@
+module MgmtConsole
+  class Client
+
+    # Methods for the SpigitConfigs API
+    module SpigitConfigs
+
+      # Get Spigit Configs list
+      #
+      # @return [Array<Sawyer::Resource>] Array of spigit configs
+      # @example Get spigit configs
+      #   @client.spigit_configs
+      def spigit_configs(options = {})
+        paginate("#{api_endpoint}/spigit_configs", options)
+      end
+
+      # Create Spigit Config
+      #
+      # @return [Sawyer::Resource] Spigit Config
+      # @example Create spigit config
+      #   @client.create_spigit_config(engage_instance_id: 'b4c2719c-10ac-487c-9af4-59c297e17766', siteid: '3-6-0-stable', config: {"SERVERNAME" => "r225.spigit.com"})
+      def create_spigit_config(options = {})
+        # Required
+        engage_instance_id = options.delete(:engage_instance_id)
+        siteid = options.delete(:siteid)
+
+        raise MgmtConsole::BadRequest.new('You must provide the Engage Instance ID as :engage_instance_id') unless engage_instance_id
+        raise MgmtConsole::BadRequest.new('You must provide the Site ID as :siteid')                        unless siteid
+
+        # Optional
+        config = options.delete(:config)
+
+        params = {
+          engage_instance_id: engage_instance_id,
+          siteid: siteid,
+          config: config,
+        }.reject { |k,v| v.nil? }
+
+        data = post("#{api_endpoint}/spigit_configs", options.merge(params))
+      end
+
+      # Update Spigit Config
+      #
+      # @return [Sawyer::Resource] Spigit Config
+      # @example Update spigit config
+      #   @client.update_spigit_config(235, config: {"SERVERNAME" => "r226.spigit.com"})
+      def update_engage_instance(id=nil, options = {})
+        # Required
+        raise MgmtConsole::BadRequest.new('You must provide the Spigit Config ID as :id') unless id
+
+        # Optional
+        engage_instance_id = options.delete(:engage_instance_id)
+        siteid = options.delete(:siteid)
+        config = options.delete(:config)
+
+        params = {
+          engage_instance_id: engage_instance_id,
+          siteid: siteid,
+          config: config,
+        }.reject { |k,v| v.nil? }
+
+        data = patch("#{api_endpoint}/spigit_configs/#{id}", options.merge(params))
+      end
+    end
+  end
+end