collins_auth 0.1.0

data/lib/collins_auth.rb

@@ -0,0 +1,70 @@
+require 'collins_client'
+require 'highline/import'
+require 'yaml'
+require 'socket'
+
+module Collins
+  module Authenticator
+    def self.setup_client(options = {prompt: false})
+      if options[:config_file] and not File.readable? options[:config_file]
+        raise 'unable to read invalid config file: ' + options[:config_file]
+      end
+
+      Collins::Client.new load_config(options)
+    end
+
+    def self.load_config(options = {})
+      conf = (read_config(options[:config_file]) || {}).merge(options) unless options[:prompt] == :only
+      
+      # check if we have all that we expect
+      if [:username, :password, :host].all? {|key| conf.keys.include? key}
+        return conf
+      end
+      
+      # Something is missing. Can we prompt for it?
+      if options[:prompt]
+        conf.merge!(prompt_creds(conf))
+      else
+        raise "could not load any valid configuration."
+      end
+      
+      conf
+    end
+    
+    private
+    def self.file2conf(file)
+      if file and File.readable? file
+        # YAML config has keys as strings but we want symbols
+        YAML.load_file(file).reduce({}) do |hash, (key, value)|
+          hash[begin key.to_sym rescue key end] = value
+          hash
+        end
+      end
+    end
+
+    def self.prompt_creds(conf={})
+      puts 'collins information:'
+      conf[:username] = ask('username: ') {|user| user.default = conf[:username] || ENV['USER']}
+      conf[:password] ||= ask('password: ') {|password| password.echo = false}
+      conf[:host]     ||= ask('host: ') {|host| host.default = ['https://collins', get_domain].compact.join('.')}
+      conf
+    end
+     
+    def self.read_config(config_file = nil)
+      config_file ||= [ENV['COLLINS_CLIENT_CONFIG'], File.join(ENV['HOME'], '.collins.yml'), '/etc/collins.yml', '/var/db/collins.yml'].compact.find do |config_file|
+        File.readable? config_file and File.size(config_file) > 0
+      end
+      
+      file2conf config_file
+    end    
+    
+    def self.get_domain
+      hostname = Socket.gethostname.downcase.split('.')
+      
+      if hostname.length > 1
+        hostname.shift
+        hostname.join('.')
+      end
+    end
+  end
+end

data/license.txt

@@ -0,0 +1,13 @@
+Copyright [2014] [Tumblr, Inc.]
+
+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.

data/readme.md

@@ -0,0 +1,42 @@
+collins_auth
+============
+
+This is a library to make it easy to obtain an authenticated collins_client object. 
+It attempts to load credentials from the following yaml files ENV['COLLINS_CLIENT_CONFIG'], ~/.collins.yml, /etc/collins.yml, /var/db/collins.yml, and supports user input.
+
+Installation
+============
+
+$ gem install collins_auth
+
+Usage
+=====
+
+    #!/usr/bin/env ruby
+    require 'collins_auth'
+
+    # setup a client from configuration files (ENV['COLLINS_CLIENT_CONFIG'], ~/.collins.yml, /etc/collins.yml or /var/db/collins.yml)
+    client = Collins::Authenticator.setup_client
+
+    # setup a client by loading an available config like above, but prompting the user for any remaining required parameters
+    client = Collins::Authenticator.setup_client prompt: true
+
+    # setup a client by prompting the user for configuration
+    client = Collins::Authenticator.setup_client prompt: :only
+    
+    client.find hostname: /^abc.+/
+
+License
+============
+
+Copyright 2014 Tumblr, Inc.
+
+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.

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: collins_auth
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Benedict
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-11-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: collins_client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: This is a library to make it easy to obtain an authenticated collins_client object. It attempts to load credentials from the following yaml files ENV['COLLINS_CLIENT_CONFIG'], ~/.collins.yml, /etc/collins.yml, /var/db/collins.yml, and supports user input.
+email: benedict@tumblr.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/collins_auth.rb
+- readme.md
+- license.txt
+homepage: https://github.com/tumblr/collins/tree/master/support/ruby/collins-auth
+licenses: 
+- Apache License 2.0
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Library to aid in getting an authenticated Collins::Client
+test_files: []
+