cyclid-client 0.3.0

data/lib/cyclid/config.rb

@@ -0,0 +1,92 @@
+# 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 'yaml'
+require 'cyclid/auth_methods'
+
+module Cyclid
+  module Client
+    # Cyclid client per-organization configuration
+    class Config
+      attr_reader :auth, :server, :port, :organization, :username, :secret, :password, :token, :path
+      # @!attribute [r] auth
+      #   @return [Fixnum] the authentication method. (Default is AUTH_HMAC)
+      # @!attribute [r] server
+      #   @return [String] the Cyclid server FQDN
+      # @!attribute [r] port
+      #   @return [Integer] the Cyclid server port. (Default is 80)
+      # @!attribute [r] organization
+      #   @return [String] the Cyclid organization that this user is associated with.
+      # @!attribute [r] username
+      #   @return [String] the Cyclid username
+      # @!attribute [r] secret
+      #   @return [String] the users HMAC signing secret
+      # @!attribute [r] password
+      #   @return [String] the users HTTP Basic password
+      # @!attribute [r] token
+      #   @return [String] the users authentication token
+      # @!attribute [r] path
+      #   @return [String] the fully qualified path to the current configuration file.
+
+      include AuthMethods
+
+      # @param [Hash] options
+      # @option options [String] :path Fully qualified path to the configuration file
+      # @option options [FixNum] :auth Authentication method
+      # @option options [String] :username Users username.
+      # @option options [String] :secret Users secret for use with HMAC authentication.
+      # @option options [String] :password Users password for use with HTTP Basic authentication.
+      # @option options [String] :token Users API token for use with Token authentication.
+      # @option options [String] :server API server address.
+      # @option options [Integer] :port API server port.
+      # @option options [String] :organization
+      def initialize(options = {})
+        # Load the config if a path was provided
+        @path = options[:path] || nil
+        @config = @path.nil? ? nil : YAML.load_file(@path)
+
+        # Select the authentication type & associated authentication data.
+        @auth = options[:auth] || AUTH_HMAC
+        case @auth
+        when AUTH_NONE
+          # Nothing
+        when AUTH_HMAC
+          @secret = options[:secret] || @config['secret']
+        when AUTH_BASIC
+          @password = options[:password] || @config['password']
+        when AUTH_TOKEN
+          @token = options[:token] || @config['token']
+        end
+
+        # Set defaults from the options
+        @server = options[:server] || nil
+        @port = options[:port] || nil
+        @organization = options[:organization] || nil
+        @username = options[:username] || nil
+
+        # Get anything provided in the config file
+        if @config
+          @server ||= @config['server']
+          @port ||= @config['port'] || 8361
+          @organization ||= @config['organization']
+          @username ||= @config['username']
+        end
+
+        # Server & Username *must* be set
+        raise 'server address must be provided' if @server.nil?
+        raise 'username must be provided' if @username.nil? and @auth != AUTH_NONE
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: cyclid-client
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Kristian Van Der Vliet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: cyclid-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Cyclid command line client for interacting with a Cyclid server and the
+  Ruby client library.
+email: vanders@liqwyd.com
+executables:
+- cyclid
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/cyclid
+- lib/cyclid/auth_methods.rb
+- lib/cyclid/cli.rb
+- lib/cyclid/cli/admin.rb
+- lib/cyclid/cli/admin/organization.rb
+- lib/cyclid/cli/admin/user.rb
+- lib/cyclid/cli/job.rb
+- lib/cyclid/cli/organization.rb
+- lib/cyclid/cli/organization/config.rb
+- lib/cyclid/cli/organization/member.rb
+- lib/cyclid/cli/secret.rb
+- lib/cyclid/cli/stage.rb
+- lib/cyclid/cli/user.rb
+- lib/cyclid/client.rb
+- lib/cyclid/client/api.rb
+- lib/cyclid/client/api/basic.rb
+- lib/cyclid/client/api/hmac.rb
+- lib/cyclid/client/api/none.rb
+- lib/cyclid/client/api/token.rb
+- lib/cyclid/client/auth.rb
+- lib/cyclid/client/health.rb
+- lib/cyclid/client/job.rb
+- lib/cyclid/client/organization.rb
+- lib/cyclid/client/stage.rb
+- lib/cyclid/client/user.rb
+- lib/cyclid/config.rb
+homepage: 
+licenses:
+- Apache-2.0
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Cyclid command line client & library
+test_files: []