dtk-shell 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fc92cd4c2d740a82221151ccefcd5df15e59a0f
+  data.tar.gz: 9bed1b89456b7868369e82380aea8fb41d1950fd
+SHA512:
+  metadata.gz: 226750e3ab5dc3bf90a381959e2c9e1634068bb005585be2b3385ccca05829eba7600b4b780d3f1bc850a7ab757700b931ea3518b71d769f5c342d202e1a49db
+  data.tar.gz: 91ae7a92aafd5721c30576dca54f3d8538fceb14bbeebfab5c311709d952b7b71e1cab0f42a9789e7558fe6a417e52a055ad4bcd0f394ce8d8c22105f0e18886

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# dependcies are defined in gemspec file since to avoid duplication
+# gemspec :name => 'dtk-client'
+gemspec

data/Gemfile_dev

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+# dependcies are defined in gemspec file since to avoid duplication
+# gemspec :name => 'dtk-shell'
+gemspec
+
+# development gems which are not included in production Gemfile
+gem 'rspec','~>3.0.0'
+gem 'awesome_print','~> 1.1.0'
+gem 'looksee'
+
+gem 'ruby-debug','0.10.4' if RUBY_VERSION == '1.8.7'
+gem 'debugger','>= 1.6.5' if RUBY_VERSION == '1.9.3'

data/README.md

@@ -0,0 +1,121 @@
+DTK Client
+==============================
+
+
+#### Description
+
+
+DTK Client is a Ruby based CLI interface for communication with the DTK Server.
+It's main purpose is to provide an easy to use interface for importing modules, browsing modules repository and deploying assemblies and topologies.
+
+---
+#### Sytstem requirements
+
+- Ruby 1.9.3
+- Unix OS
+
+---
+#### Installation
+
+For DTK Client to work, following steps have to be done:
+
+- Git User set up
+- RSA Keys Generated
+
+To install DTK Client gem, execute:
+
+`gem install dtk-client`
+
+---
+#### Initial setup
+
+There are two ways for DTK Client to run
+
+- via an interactive shell (<tt>dtk-shell</tt>)
+- by executing DTK Client commands (ie. <tt>dtk service list</tt>)
+
+If it is the first time that the DTK Client is being used (by either of the ways), following prompts will appear:
+
+```
+Please enter the DTK server address (example: instance.dtk.io)
+Server address:
+
+Please enter your DTK login details
+Username:
+Password:
+
+```
+After entering the correct data, following message will appear:
+
+`SSH key 'dtk-client' added successfully!`
+
+This means that the DTK Server has successfully registered DTK Client and the client is ready for use.
+
+---
+#### DTK Client configuration
+
+All of the DTK Configuration, installed component and service modules as well as client logs are located in `~/dtk`.
+
+DTK Client configuration options, such as development option, verbose calls to DTK Server, log options and Client user credentials, can be configured in `~/dtk/client.conf`:
+
+```
+debug_task_frequency=5            # assembly - frequency between requests (seconds)
+auto_commit_changes=false         # autocommit for modules
+verbose_rest_calls=false          # logging of REST calls
+
+module_location=component_modules
+service_location=service_modules
+test_module_location=test_modules
+backups_location=backups
+
+
+server_port=80
+secure_connection_server_port=443
+secure_connection=true
+server_host=instance.dtk.io
+```
+
+
+User credentials are located in `~/dtk/.connection`
+
+Component and Service modules that are installed, or modules that are imported are located in `~/dtk/component_modules` and `~/dtk/service_modules/`
+
+---
+
+## Advanced features
+#### Development mode
+
+When using DTK Client in Development mode, gems from `Gemfile_dev` must be installed and used when running DTK Client or DTK Client Shell:
+
+```
+bundle install --gemfile Gemfile_dev
+BUNDLE_GEMFILE=Gemfile_dev bundle exec ruby ./bin/dtk-shell
+```
+
+#### DTK Repoman
+
+DTK Repoman is a Git based repository for publishing and installing component modules and service modules. DTK Repoman has it's own users, known as catalog users. The inital setup should register the DTK Client to the Public Catalog users.
+
+Successfully registered DTK Client on DTK Repoman enables execution of commands such as:
+
+`dtk service-module list --remote` - lists service moduels on remote visible to the catalog user
+
+`dtk component-module install namespace/component-module-name` - install component module
+
+Switching from public user to a commercial user can be done with `dtk account set-catalog-credentials`. This will initate a prompt for catalog username and password
+
+## License
+
+dtk-client is copyright (C) 2010-2016 dtk contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this work except in compliance with the License.
+You may obtain a copy of the License in the [LICENSE](LICENSE) file, or 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/bin/dtk-execute

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# 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.
+#
+
+require File.expand_path('../lib/client', File.dirname(__FILE__))
+require File.expand_path('../lib/execute', File.dirname(__FILE__))
+require File.expand_path('../lib/configurator', File.dirname(__FILE__))
+
+include DTK::Client
+
+Configurator.check_config_exists
+
+# if connection parameters are not set up properly, print warning and exit dtk_shell
+conn = Session.get_connection()
+exit if validate_connection(conn)
+
+Execute::Script.execute()

data/bin/dtk-run

@@ -0,0 +1,92 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# 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.
+#
+
+# GLOBAL IDENTIFIER
+$shell_mode = false
+
+require File.expand_path('../lib/client', File.dirname(__FILE__))
+require File.expand_path('../lib/configurator', File.dirname(__FILE__))
+require File.expand_path('../lib/parser/adapters/thor', File.dirname(__FILE__))
+require File.expand_path('../lib/shell/context', File.dirname(__FILE__))
+require File.expand_path('../lib/shell/domain/context_entity', File.dirname(__FILE__))
+require File.expand_path('../lib/shell/domain/active_context', File.dirname(__FILE__))
+require File.expand_path('../lib/shell/domain/context_params', File.dirname(__FILE__))
+require File.expand_path('../lib/shell/domain/override_tasks', File.dirname(__FILE__))
+require File.expand_path('../lib/shell/domain/shadow_entity', File.dirname(__FILE__))
+require File.expand_path('../lib/commands/thor/account', File.dirname(__FILE__))
+require File.expand_path('../lib/shell/parse_monkey_patch', File.dirname(__FILE__))
+require File.expand_path('../lib/shell/help_monkey_patch', File.dirname(__FILE__))
+require File.expand_path('../lib/execute/cli_pure/cli_rerouter', File.dirname(__FILE__))
+
+paths = []
+paths << File.expand_path('../lib/commands/thor/*.rb', File.dirname(__FILE__))
+paths << File.expand_path('../lib/commands/common/thor/*.rb', File.dirname(__FILE__))
+
+paths.each do |path|
+  Dir[path].each do |thor_class_file|
+    require thor_class_file
+  end
+end
+
+
+
+require 'shellwords'
+require 'json'
+
+$: << "/usr/lib/ruby/1.8/" #TODO: put in to get around path problem in rvm 1.9.2 environment
+
+config_exists = ::DTK::Client::Configurator.check_config_exists
+::DTK::Client::Configurator.check_git
+::DTK::Client::Configurator.create_missing_clone_dirs
+
+
+# check if .add_direct_access file exists, if not then add direct access and create .add_direct_access file
+resolve_direct_access(::DTK::Client::Configurator.check_direct_access, config_exists)
+entries = []
+
+if ARGV.size > 0
+  entries = ARGV
+  entries = DTK::Shell::Context.check_for_sym_link(entries)
+  entity_name = entries.shift
+end
+
+# special case for when no params are provided use help method
+if (entity_name == 'help' || entity_name.nil?)
+  entity_name = 'dtk'
+  args = ['help']
+else
+  args = entries
+end
+
+context = DTK::Shell::Context.new(true)
+
+begin
+  if ::DTK::CLIRerouter.is_candidate?(entity_name, args)
+    response_obj = ::DTK::CLIRerouter.new(entity_name, args).run()
+    puts response_obj.to_json
+  else
+    # default execution
+    entity_name, method_name, context_params, thor_options = context.get_dtk_command_parameters(entity_name, args)
+    top_level_execute(entity_name, method_name, context_params, thor_options, false)
+  end
+rescue DTK::Client::DtkError => e
+  DtkLogger.instance.error(e.message, true)
+rescue Exception => e
+  DtkLogger.instance.error_pp(e.message, e.backtrace)
+end

data/bin/dtk-shell

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# 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.
+#
+require File.expand_path('../lib/shell', File.dirname(__FILE__))
+require File.expand_path('../lib/commands/thor/account', File.dirname(__FILE__))
+
+trap("INT", "SIG_IGN")
+
+config_exists = ::DTK::Client::Configurator.check_config_exists
+::DTK::Client::Configurator.check_git
+::DTK::Client::Configurator.create_missing_clone_dirs
+
+# check if .add_direct_access file exists, if not then add direct access and create .add_direct_access file
+resolve_direct_access(::DTK::Client::Configurator.check_direct_access, config_exists)
+
+run_shell_command()

data/dtk-shell.gemspec

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dtk-shell/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Rich PELAVIN"]
+  gem.email         = ["rich@reactor8.com"]
+  gem.description   = %q{The DTK Client is a command line tool to interact with your DTK Server and DTK Service Catalog instance(s).}
+  gem.summary       = %q{DTK CLI client for DTK server interaction.}
+  gem.homepage      = "https://github.com/rich-reactor8/dtk-shell"
+  gem.licenses      = ["Apache-2.0"]
+
+  gem.files = %w(README.md Gemfile Gemfile_dev dtk-shell.gemspec)
+  gem.files += Dir.glob("bin/**/*")
+  gem.files += Dir.glob("lib/**/*")
+  gem.files += Dir.glob("puppet/**/*")
+  gem.files += Dir.glob("spec/**/*")
+  gem.files += Dir.glob("views/**/*")
+
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "dtk-shell"
+  gem.require_paths = ["lib"]
+  gem.version       = DtkShell::VERSION
+
+  gem.add_dependency 'mime-types','~> 1.25'
+  gem.add_dependency 'bundler','>= 1.2.4'
+  gem.add_dependency 'json_pure' ,'1.7.4'
+  gem.add_dependency 'diff-lcs','1.2.0'
+  gem.add_dependency 'hirb','~> 0.7.0'
+  gem.add_dependency 'thor','~> 0.15.4'
+  gem.add_dependency 'erubis','~> 2.7.0'
+  gem.add_dependency 'dtk-common-core','0.10.0'
+  gem.add_dependency 'git','1.2.9'
+  # gem.add_dependency 'colorize','~> 0.5.8'
+  gem.add_dependency 'colorize', '0.7.7'
+  gem.add_dependency 'highline', '1.7.8'
+  gem.add_dependency 'awesome_print', '1.1.0'
+
+  # gem.add_dependency 'rb-readline', '0.5.0'
+  # gem.add_dependency 'activesupport','~> 3.2.12'
+  # gem.add_dependency 'i18n','0.6.1'
+  # gem.add_dependency 'puppet','~> 3.1.0'
+  # gem.add_dependency 'jenkins-client','~> 0.0.1'
+  # gem.add_dependency 'rspec','~> 2.12.0'
+  # gem.add_dependency 'awesome_print','~> 1.1.0'
+  # gem.add_dependency 'rdoc','= 3.12.1'l
+  # gem.add_development_dependency 'ruby-debug','>= 0.10.4'
+  # gem.add_development_dependency 'awesome_print','>= 1.1.0'
+  # gem.add_development_dependency 'rspec','~> 2.12.0'
+end

data/lib/auxiliary.rb

@@ -0,0 +1,61 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# 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.
+#
+module DTK
+  module Client
+    module Auxiliary
+      def cap_form(x)
+        x.gsub('-','_').to_s.split("_").map{|t|t.capitalize}.join("")
+      end
+
+      def snake_form(command_class,seperator="_")
+        command_class.to_s.gsub(/^.*::/, '').gsub(/Command$/,'').scan(/[A-Z][a-z]+/).map{|w|w.downcase}.join(seperator)
+      end
+    end
+
+    class PostBody < Hash
+      def initialize(raw={})
+        super()
+        unless raw.empty?
+          replace(convert(raw))
+        end
+      end
+      def merge(raw)
+        super(convert(raw))
+      end
+      def merge!(raw)
+        super(convert(raw))
+      end
+
+     private
+      def convert(raw)
+        raw.inject(Hash.new) do |h,(k,v)|
+          if non_null_var = is_only_non_null_var?(k)
+            v.nil? ? h : h.merge(non_null_var => v)
+          else
+            h.merge(k => v)
+          end
+        end
+      end
+      def is_only_non_null_var?(k)
+        if k.to_s =~ /\?$/
+          k.to_s.gsub(/\?$/,'').to_sym
+        end
+      end
+    end
+  end
+end

data/lib/bundler_monkey_patch.rb

@@ -0,0 +1,26 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# 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.
+#
+module Bundler
+  module SharedHelpers
+
+    private 
+    def find_gemfile
+    	File.expand_path('../Gemfile', File.dirname(__FILE__))
+    end
+  end
+end