cyclid-client 0.3.0

data/lib/cyclid/cli/user.rb

@@ -0,0 +1,84 @@
+# Copyright 2016 Liqwyd Ltd.
+#
+# 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 'colorize'
+
+# Cyclid top level module
+module Cyclid
+  module Cli
+    # 'user' sub-command
+    class User < Thor
+      desc 'show', 'Show your user details'
+      def show
+        user = client.user_get(client.config.username)
+
+        # Pretty print the user details
+        puts 'Username: '.colorize(:cyan) + user['username']
+        puts 'Name: '.colorize(:cyan) + (user['name'] || '')
+        puts 'Email: '.colorize(:cyan) + user['email']
+        puts 'Organizations'.colorize(:cyan)
+        if user['organizations'].any?
+          user['organizations'].each do |org|
+            puts "\t#{org}"
+          end
+        else
+          puts "\tNone"
+        end
+      rescue StandardError => ex
+        abort "Failed to get user: #{ex}"
+      end
+
+      desc 'modify', 'Modify your user'
+      long_desc <<-LONGDESC
+        Modify your user details.
+
+        The --email option sets your email address.
+
+        The --password option sets an encrypted password for HTTP Basic authentication and Cyclid
+        UI console logins.
+
+        The --secret option sets a shared secret which is used for signing Cyclid API requests.
+      LONGDESC
+      option :email, aliases: '-e'
+      option :password, aliases: '-p'
+      option :secret, aliases: '-s'
+      def modify
+        client.user_modify(client.config.username,
+                           email: options[:email],
+                           password: options[:password],
+                           secret: options[:secret])
+      rescue StandardError => ex
+        abort "Failed to modify user: #{ex}"
+      end
+
+      desc 'passwd', 'Change your password'
+      def passwd
+        # Get the new password
+        print 'Password: '
+        password = STDIN.noecho(&:gets).chomp
+        print "\nConfirm password: "
+        confirm = STDIN.noecho(&:gets).chomp
+        print "\n"
+        abort 'Passwords do not match' unless password == confirm
+
+        # Modify the user with the new password
+        begin
+          client.user_modify(client.config.username, password: password)
+        rescue StandardError => ex
+          abort "Failed to modify user: #{ex}"
+        end
+      end
+    end
+  end
+end

data/lib/cyclid/client.rb

@@ -0,0 +1,98 @@
+# Copyright 2016 Liqwyd Ltd.
+#
+# 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 'securerandom'
+require 'oj'
+require 'yaml'
+require 'logger'
+
+require 'cyclid/config'
+require 'cyclid/auth_methods'
+
+require 'cyclid/client/api'
+require 'cyclid/client/user'
+require 'cyclid/client/organization'
+require 'cyclid/client/job'
+require 'cyclid/client/stage'
+require 'cyclid/client/auth'
+require 'cyclid/client/health'
+
+module Cyclid
+  # Cyclid client methods
+  module Client
+    # Tilapia is the standard Cyclid Ruby client. It provides an inteligent
+    # programmable API on top of the standard Cyclid REST API, complete with
+    # automatic signing of HTTP requests and HTTP error handling.
+    #
+    # The client provides interfaces for managing Users, Organizations, Stages
+    # & Jobs. Refer to the documentation for those modules for more information.
+    #
+    # In case you're wondering, this class required a name: it couldn't be
+    # 'Cyclid' and it couldn't be 'Client'. Tilapia are a common type of
+    # Cichlid...
+    class Tilapia
+      attr_reader :config, :logger
+      # @!attribute [r] config
+      #   @return [Config] Client configuration object
+      # @!attribute [r] logger
+      #   @return [Logger] Client logger object
+
+      # @param [Hash] options
+      # @option options [String] :config_path Fully qualified path to the configuration file
+      # @option options [FixNum] :log_level Logger output level
+      def initialize(options)
+        @config = Config.new(options)
+
+        # Create a logger
+        log_level = options[:log_level] || Logger::FATAL
+        @logger = Logger.new(STDERR)
+        @logger.level = log_level
+
+        # Select the API methods to use
+        @api = case @config.auth
+               when AuthMethods::AUTH_NONE
+                 Api::None.new(@config, @logger)
+               when AuthMethods::AUTH_HMAC
+                 Api::Hmac.new(@config, @logger)
+               when AuthMethods::AUTH_BASIC
+                 Api::Basic.new(@config, @logger)
+               when AuthMethods::AUTH_TOKEN
+                 Api::Token.new(@config, @logger)
+               end
+      end
+
+      include User
+      include Organization
+      include Job
+      include Stage
+      include Auth
+      include Health
+
+      private
+
+      # Build a URI for the configured server & required resource
+      def server_uri(path)
+        URI::HTTP.build(host: @config.server,
+                        port: @config.port,
+                        path: path)
+      end
+
+      def method_missing(method, *args, &block)
+        @api.send(method, *args, &block)
+      end
+    end
+
+    include AuthMethods
+  end
+end

data/lib/cyclid/client/api.rb

@@ -0,0 +1,114 @@
+# Copyright 2016 Liqwyd Ltd.
+#
+# 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 'uri'
+require 'net/http'
+
+module Cyclid
+  # Cyclid client methods
+  module Client
+    # Client API request methods
+    module Api
+      # Base class for API request implementations
+      class Base
+        def initialize(config, logger)
+          @config = config
+          @logger = logger
+        end
+
+        # Add authentication details & perform a GET request
+        def api_get(uri)
+          req = authenticate_request(Net::HTTP::Get.new(uri), uri)
+
+          api_request(uri, req)
+        end
+
+        # Add authentication details perform a POST request with a pre-formatted body
+        def api_raw_post(uri, data, content_type)
+          unsigned = Net::HTTP::Post.new(uri)
+          unsigned.content_type = content_type
+          unsigned.body = data
+
+          req = authenticate_request(unsigned, uri)
+
+          api_request(uri, req)
+        end
+
+        # Add authentication details perform a POST request with a JSON body
+        def api_json_post(uri, data)
+          json = Oj.dump(data)
+          api_raw_post(uri, json, 'application/json')
+        end
+
+        # Add authentication details perform a POST request with a YAML body
+        def api_yaml_post(uri, data)
+          yaml = YAML.dump(data)
+          api_raw_post(uri, yaml, 'application/x-yaml')
+        end
+
+        # Add authentication details perform a PUT request with a JSON body
+        def api_json_put(uri, data)
+          unsigned = Net::HTTP::Put.new(uri)
+          unsigned.content_type = 'application/json'
+          unsigned.body = Oj.dump(data)
+
+          req = authenticate_request(unsigned, uri)
+
+          api_request(uri, req)
+        end
+
+        # Add authentication details perform a DELETE request
+        def api_delete(uri)
+          req = authenticate_request(Net::HTTP::Delete.new(uri), uri)
+
+          api_request(uri, req)
+        end
+
+        # Perform an API HTTP request & return the parsed response body
+        def api_request(uri, req)
+          http = Net::HTTP.new(uri.hostname, uri.port)
+          res = http.request(req)
+
+          parse_response(res)
+        end
+
+        # Parse, validate & handle response data
+        def parse_response(res)
+          response_data = Oj.load(res.body)
+
+          # Return immediately if the response was an HTTP 200 OK
+          return response_data if res.code == '200'
+
+          @logger.info "server request failed with error ##{res.code}: \
+                       #{response_data['description']}"
+          raise response_data['description']
+        rescue Oj::ParseError => ex
+          @logger.debug "body: #{res.body}\n#{ex}"
+          raise 'failed to decode server response body'
+        end
+
+        # The API does not support non-authenticated requests, so this method
+        # must be implemented.
+        def authenticate_request(_request, _uri)
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end
+
+require 'cyclid/client/api/none'
+require 'cyclid/client/api/hmac'
+require 'cyclid/client/api/basic'
+require 'cyclid/client/api/token'

data/lib/cyclid/client/api/basic.rb

@@ -0,0 +1,30 @@
+# Copyright 2016 Liqwyd Ltd.
+#
+# 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 Cyclid
+  # Cyclid client methods
+  module Client
+    # Client API HTTP methods
+    module Api
+      # HTTP Basic auth HTTP methods
+      class Basic < Base
+        # Add the username & password to the request
+        def authenticate_request(request, _uri)
+          request.basic_auth(@config.username, @config.password)
+          return request
+        end
+      end
+    end
+  end
+end

data/lib/cyclid/client/api/hmac.rb

@@ -0,0 +1,59 @@
+# Copyright 2016 Liqwyd Ltd.
+#
+# 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 'cyclid/hmac'
+
+module Cyclid
+  # Cyclid client methods
+  module Client
+    # Client API HTTP methods
+    module Api
+      # HMAC signed HTTP methods
+      class Hmac < Base
+        # Sign the request with HMAC
+        def authenticate_request(request, uri)
+          algorithm = 'sha256'
+          signer = Cyclid::HMAC::Signer.new(algorithm)
+
+          method = if request.is_a? Net::HTTP::Get
+                     'GET'
+                   elsif request.is_a? Net::HTTP::Post
+                     'POST'
+                   elsif request.is_a? Net::HTTP::Put
+                     'PUT'
+                   elsif request.is_a? Net::HTTP::Delete
+                     'DELETE'
+                   else
+                     raise "invalid request method #{request.inspect}"
+                   end
+
+          nonce = SecureRandom.hex
+          headers = signer.sign_request(uri.path,
+                                        @config.secret,
+                                        auth_header_format: '%{auth_scheme} %{username}:%{signature}', # rubocop:disable Metrics/LineLength
+                                        username: @config.username,
+                                        nonce: nonce,
+                                        method: method)
+
+          headers[0].each do |k, v|
+            request[k] = v
+          end
+          request['X-HMAC-Algorithm'] = algorithm
+
+          return request
+        end
+      end
+    end
+  end
+end

data/lib/cyclid/client/api/none.rb

@@ -0,0 +1,29 @@
+# Copyright 2016 Liqwyd Ltd.
+#
+# 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 Cyclid
+  # Cyclid client methods
+  module Client
+    # Client API HTTP methods
+    module Api
+      # Only works for non-authenticated request (E.g. healthchecks)
+      class None < Base
+        # Do nothing
+        def authenticate_request(request, _uri)
+          request
+        end
+      end
+    end
+  end
+end

data/lib/cyclid/client/api/token.rb

@@ -0,0 +1,30 @@
+# Copyright 2016 Liqwyd Ltd.
+#
+# 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 Cyclid
+  # Cyclid client methods
+  module Client
+    # Client API HTTP methods
+    module Api
+      # JWT token based HTTP methods
+      class Token < Base
+        # Add the token to the request
+        def authenticate_request(request, _uri)
+          request.add_field('Authorization', "Token #{@config.username}:#{@config.token}")
+          return request
+        end
+      end
+    end
+  end
+end