cyclid-client 0.3.0

data/lib/cyclid/client/auth.rb

@@ -0,0 +1,36 @@
+# 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
+  module Client
+    # Authentication related methods
+    module Auth
+      # Retrieve a JWT token from the server.
+      # @param username [String] User name of the user to retrieve a token for.
+      # @param claims [Hash] additional JWT claims to append to the token.
+      # @return [Hash] Decoded server response object.
+      # @example Request a simple token
+      #   token_data = token_get
+      # @example Request a token with a CSRF injected into the claims
+      #   token_data = token_get(csrf: 'abcdef0123456789')
+      def token_get(username, claims = {})
+        uri = server_uri("/token/#{username}")
+        res_data = api_json_post(uri, claims)
+        @logger.debug res_data
+
+        return res_data
+      end
+    end
+  end
+end

data/lib/cyclid/client/health.rb

@@ -0,0 +1,34 @@
+# 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
+  module Client
+    # Health-check related methods
+    module Health
+      # Ping the API server.
+      # @return [Boolean] True if the API server is healthy, false if it is unhealthy.
+      def health_ping
+        uri = server_uri('/health/status')
+
+        # We need to do without the API helpers as the health endpoint won't
+        # return any data, just an HTTP status
+        req = authenticate_request(Net::HTTP::Get.new(uri), uri)
+        http = Net::HTTP.new(uri.hostname, uri.port)
+        res = http.request(req)
+
+        return res.code == '200'
+      end
+    end
+  end
+end

data/lib/cyclid/client/job.rb

@@ -0,0 +1,88 @@
+# 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
+  module Client
+    # Job related methods
+    module Job
+      # Submit a job
+      # @param organization [String] Organization name.
+      # @param job [String] Raw job data in either JSON or YAML
+      # @param type [String] Job data format; either 'json' or 'yaml'
+      # @return [Hash] Decoded server response object.
+      # @example Submit a job in JSON format
+      #   job = File.read('job.json')
+      #   job_submit('example', job, 'json')
+      # @example Submit a job in YAML format
+      #   job = File.read('job.yml')
+      #   job_submit('example', job, 'yaml')
+      def job_submit(organization, job, type)
+        uri = server_uri("/organizations/#{organization}/jobs")
+        case type
+        when 'yaml'
+          res_data = api_raw_post(uri, job, 'application/x-yaml')
+        when 'json'
+          res_data = api_raw_post(uri, job, 'application/json')
+        else
+          raise "Unknown job format #{type}"
+        end
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Get details of a job
+      # @param organization [String] Organization name.
+      # @param jobid [Integer] Job ID to retrieve. The ID must be a valid job for the organization.
+      # @return [Hash] Decoded server response object.
+      # @see #job_status
+      # @see #job_log
+      def job_get(organization, jobid)
+        uri = server_uri("/organizations/#{organization}/jobs/#{jobid}")
+        res_data = api_get(uri)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Get a job status
+      # @param organization [String] Organization name.
+      # @param jobid [Integer] Job ID to retrieve. The ID must be a valid job for the organization.
+      # @return [Hash] Decoded server response object.
+      # @see #job_get
+      # @see #job_log
+      def job_status(organization, jobid)
+        uri = server_uri("/organizations/#{organization}/jobs/#{jobid}/status")
+        res_data = api_get(uri)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Get a job log
+      # @param organization [String] Organization name.
+      # @param jobid [Integer] Job ID to retrieve. The ID must be a valid job for the organization.
+      # @return [Hash] Decoded server response object.
+      # @see #job_get
+      # @see #job_status
+      def job_log(organization, jobid)
+        uri = server_uri("/organizations/#{organization}/jobs/#{jobid}/log")
+        res_data = api_get(uri)
+        @logger.debug res_data
+
+        return res_data
+      end
+    end
+  end
+end

data/lib/cyclid/client/organization.rb

@@ -0,0 +1,187 @@
+# 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
+  module Client
+    # Organization related methods
+    module Organization
+      # Retrieve the list of organizations from a server
+      # @return [Array] List of organization names.
+      def org_list
+        uri = server_uri('/organizations')
+        res_data = api_get(uri)
+        @logger.debug res_data
+
+        orgs = []
+        res_data.each do |item|
+          orgs << item['name']
+        end
+
+        return orgs
+      end
+
+      # Get details of a specific organization
+      # @param name [String] organization name.
+      # @return [Hash] Decoded server response object.
+      def org_get(name)
+        uri = server_uri("/organizations/#{name}")
+        res_data = api_get(uri)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Create a new organization. The organization is created without any
+      # members; use org_modify to add a set of users to the organization
+      # after it has been created.
+      #
+      # @param name [String] organization name.
+      # @param email [String] organization owners email address.
+      # @return [Hash] Decoded server response object.
+      # @example Create a new organization 'example'
+      #   new_org = org_add('example', 'admin@example.com')
+      # @see #org_modify
+      def org_add(name, email)
+        # Create the organization object
+        org = { 'name' => name, 'owner_email' => email }
+        @logger.debug org
+
+        # Sign & send the request
+        uri = server_uri('/organizations')
+        res_data = api_json_post(uri, org)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Modify an organization. Only the owner email address and organization
+      # members can be changed; you can not change the name of an organization
+      # once it has been created.
+      #
+      # @note Setting the organization members will *overwrite* the existing
+      #   set; you should ensure the set of members is complete before you set it.
+      # @param name [String] organization name.
+      # @param args [Hash] options to modify the organization.
+      # @option args [String] owner_email Organization owners email address.
+      # @option args [Array] members Set of users who will be organization members.
+      # @return [Hash] Decoded server response object.
+      # @see #org_add
+      # @see #org_delete
+      def org_modify(name, args)
+        # Create the organization object
+        org = {}
+
+        # Add the owner email address if one was supplied
+        org['owner_email'] = args[:owner_email] \
+          if args.key? :owner_email and args[:owner_email]
+
+        # Add the list of members if it was supplied
+        org['users'] = args[:members] \
+          if args.key? :members and args[:members]
+
+        @logger.debug org
+
+        # Sign & send the request
+        uri = server_uri("/organizations/#{name}")
+        res_data = api_json_put(uri, org)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Get details of an organization member
+      # @param name [String] organization name.
+      # @param username [String] member username.
+      # @return [Hash] Decoded server response object.
+      # @see User#user_get
+      def org_user_get(name, username)
+        uri = server_uri("/organizations/#{name}/members/#{username}")
+        res_data = api_get(uri)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Modify the permissions for an organization member
+      # @param name [String] organization name.
+      # @param username [String] member username.
+      # @param permissions [Hash] permissions to apply to the member.
+      # @option permissions [Boolean] admin organization 'admin' permission.
+      # @option permissions [Boolean] write organization 'write' permission.
+      # @option permissions [Boolean] read organization 'read' permission.
+      # @return [Hash] Decoded server response object.
+      # @see #org_modify
+      # @example Give the user 'leslie' read & write permission to the 'example' organization
+      #   perms = {admin: false, write: true, read: true}
+      #   org_user_permissions('example', 'leslie', perms)
+      def org_user_permissions(name, username, permissions)
+        perms = { 'permissions' => permissions }
+
+        @logger.debug perms
+
+        uri = server_uri("/organizations/#{name}/members/#{username}")
+        res_data = api_json_put(uri, perms)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Get a plugin configuration for an organization.
+      # @param name [String] organization name.
+      # @param type [String] plugin 'type'
+      # @param plugin [String] plugin name.
+      # @return [Hash] Decoded server response object.
+      # @see #org_config_set
+      # @example Get the plugin config & schema for the 'foo' 'api' type plugin, for the 'example'
+      # organization
+      #   org_config_get('example', 'api', 'foo')
+      def org_config_get(name, type, plugin)
+        uri = server_uri("/organizations/#{name}/configs/#{type}/#{plugin}")
+        res_data = api_get(uri)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Update a plugin configuration for an organization.
+      # @param name [String] organization name.
+      # @param type [String] plugin 'type'
+      # @param plugin [String] plugin name.
+      # @param config [Hash] plugin configuration data.
+      # @return [Hash] Decoded server response object.
+      # @see #org_config_get
+      def org_config_set(name, type, plugin, config)
+        uri = server_uri("/organizations/#{name}/configs/#{type}/#{plugin}")
+        res_data = api_json_put(uri, config)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Delete an organization
+      # @note The API does not currently support deleting an organization and
+      #   this method will always fail.
+      # @param name [String] organization name.
+      # @return [Hash] Decoded server response object.
+      # @see #org_add
+      def org_delete(name)
+        uri = server_uri("/organizations/#{name}")
+        res_data = api_delete(uri)
+        @logger.debug res_data
+
+        return res_data
+      end
+    end
+  end
+end

data/lib/cyclid/client/stage.rb

@@ -0,0 +1,79 @@
+# 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
+  module Client
+    # Stage related methods
+    module Stage
+      # Retrieve the list of stages from a server
+      # @param organization [String] Organization name.
+      # @return [Array] The list of stages. Each entry is a hash with the name
+      #   & version of the stage.
+      def stage_list(organization)
+        uri = server_uri("/organizations/#{organization}/stages")
+        res_data = api_get(uri)
+        @logger.debug res_data
+
+        stages = []
+        res_data.each do |item|
+          stages << { name: item['name'], version: item['version'] }
+        end
+
+        return stages
+      end
+
+      # Get details of a stage
+      # @param organization [String] Organization name.
+      # @param name [String] Name of the stage to retrieve.
+      # @return [Hash] Decoded server response object.
+      def stage_get(organization, name)
+        uri = server_uri("/organizations/#{organization}/stages/#{name}")
+        res_data = api_get(uri)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Create a stage
+      # @param organization [String] Organization name.
+      # @param stage [String] Raw stage definition, in JSON format.
+      # @return [Hash] Decoded server response object.
+      # @see #stage_modify
+      # @example Create a new stage from a file
+      #   stage = File.read('stage.json')
+      #   stage_create('example, stage)
+      def stage_create(organization, stage)
+        uri = server_uri("/organizations/#{organization}/stages")
+        res_data = api_json_post(uri, stage)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Modify a stage.
+      # @note Stages are immutable; this actually creates a new version of an existing stage.
+      # @param organization [String] Organization name.
+      # @param stage [String] Raw stage definition, in JSON format.
+      # @return [Hash] Decoded server response object.
+      # @see #stage_create
+      def stage_modify(organization, stage)
+        uri = server_uri("/organizations/#{organization}/stages")
+        res_data = api_json_post(uri, stage)
+        @logger.debug res_data
+
+        return res_data
+      end
+    end
+  end
+end

data/lib/cyclid/client/user.rb

@@ -0,0 +1,134 @@
+# 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 'bcrypt'
+
+module Cyclid
+  module Client
+    # User related methods
+    module User
+      # Retrieve the list of users from a server
+      # @return [Array] List of user names.
+      def user_list
+        uri = server_uri('/users')
+        res_data = api_get(uri)
+        @logger.debug res_data
+
+        users = []
+        res_data.each do |item|
+          users << item['username']
+        end
+
+        return users
+      end
+
+      # Get details of a specific user
+      # @param username [String] User name of the user to retrieve.
+      # @return [Hash] Decoded server response object.
+      def user_get(username)
+        uri = server_uri("/users/#{username}")
+        res_data = api_get(uri)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Create a new user
+      # @param username [String] User name of the new user.
+      # @param name [String] Users real name.
+      # @param email [String] Users email address.
+      # @param password [String] Unencrypted initial password
+      # @param secret [String] Initial HMAC signing secret
+      # @return [Hash] Decoded server response object.
+      # @see #user_modify
+      # @see #user_delete
+      def user_add(username, email, name = nil, password = nil, secret = nil)
+        # Create the user object
+        user = { 'username' => username, 'email' => email }
+
+        # Add the real name is one was supplied
+        user['name'] = name unless name.nil?
+
+        # Add the HMAC secret if one was supplied
+        user['secret'] = secret unless secret.nil?
+
+        # Encrypt & add the password if one was supplied
+        user['password'] = BCrypt::Password.create(password).to_s unless password.nil?
+
+        @logger.debug user
+
+        # Sign & send the request
+        uri = server_uri('/users')
+        res_data = api_json_post(uri, user)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Modify a user
+      # @param username [String] User name of the new user.
+      # @param args [Hash] options to modify the user.
+      # @option args [String] name Users real name.
+      # @option args [String] email Users email address.
+      # @option args [String] secret Initial HMAC signing secret
+      # @option args [String] password Unencrypted initial password
+      # @return [Hash] Decoded server response object.
+      # @see #user_add
+      # @see #user_delete
+      # @example Change the email address of the user 'leslie'
+      #   user_modify('leslie', email: 'leslie@example.com')
+      # @example Change the password & secret of the user 'bob'
+      #   user_modify('bob', secret: 'sekrit', password: 'm1lkb0ne')
+      def user_modify(username, args)
+        # Create the user object
+        user = {}
+
+        # Add the real name is one was supplied
+        user['name'] = args[:name] if args.key? :name and args[:name]
+
+        # Add the email address if one was supplied
+        user['email'] = args[:email] if args.key? :email and args[:email]
+
+        # Add the HMAC secret if one was supplied
+        user['secret'] = args[:secret] if args.key? :secret and args[:secret]
+
+        # Encrypt & add the password if one was supplied
+        user['password'] = BCrypt::Password.create(args[:password]).to_s \
+          if args.key? :password and args[:password]
+
+        @logger.debug user
+
+        # Sign & send the request
+        uri = server_uri("/users/#{username}")
+        res_data = api_json_put(uri, user)
+        @logger.debug res_data
+
+        return res_data
+      end
+
+      # Delete a user
+      # @param username [String] User name of the user to delete.
+      # @return [Hash] Decoded server response object.
+      # @see #user_add
+      # @see #user_modify
+      def user_delete(username)
+        uri = server_uri("/users/#{username}")
+        res_data = api_delete(uri)
+        @logger.debug res_data
+
+        return res_data
+      end
+    end
+  end
+end