hieraviz 0.1.2 → 0.2.0

data/app/views/_layout.erb

@@ -11,7 +11,9 @@
     <script src="/js/base-switch.js"></script>
     <% end -%>
     <% if session['access_token'] -%>
-    <script>var session_key = "<%= session['access_token'] %>";</script>
+    <script>
+      var session_key = "<%= session['access_token'] %>";
+    </script>
     <% end -%>
     <%= yield_content :more_js %>
   </head>

data/app/views/home.erb

@@ -3,6 +3,6 @@ Welcome to hieraviz<br>
 
 <% if settings.configdata['debug'] -%>
 <%= session['access_token'] %><br>
-<pre><%= Hieraviz::Store.get session['access_token'] if session['access_token'] %></pre>
+<pre><%= settings.store.get(session['access_token'], settings.configdata['session_renew']) if session['access_token'] %></pre>
 </div>
 <% end %>

data/app/views/store.erb

@@ -1,6 +1,6 @@
 <div class="meat text">
 <h1>Store</h1>
 <%= session['access_token'] %><br>
-<pre><%= Hieraviz::Store.dump %></pre>
-<pre><%= Hieraviz::Store.tmpdir %></pre>
+<pre><%= settings.store.dump %></pre>
+<pre><%= settings.store.tmpdir %></pre>
 </div>

data/app/web.rb

@@ -11,14 +11,15 @@ require 'hieraviz'
 require File.expand_path '../common.rb', __FILE__
 
 module HieravizApp
+  # the unique web endpoints management
   class Web < Common
     helpers Sinatra::ContentFor
     register Sinatra::Flash
 
     configure do
       set :session_secret, settings.configdata['session_seed']
-      set :public_folder, Proc.new { File.join(root, "public") }
-      set :views_folder, Proc.new { File.join(root, "views") }
+      set :public_folder, -> { File.join(root, 'public') }
+      set :views_folder, -> { File.join(root, 'views') }
       set :erb, layout: :_layout
       enable :sessions
     end
@@ -32,26 +33,29 @@ module HieravizApp
     when 'dummy'
 
       get '/logout' do
-        session.delete :access_token
+        session.delete 'access_token'
         erb :logout
       end
 
       get '/login' do
-        session[:access_token] = '0000'
+        session['access_token'] = '0000'
         redirect '/'
       end
 
       helpers do
         def check_authorization
-          'dummy'
+          if session['access_token']
+            return 'dummy'
+          end
+          false
         end
       end
 
     when 'http'
 
-      use Rack::Auth::Basic, "Puppet Private Access" do |username, password|
-        username == settings.configdata['http_auth']['username'] && 
-        password == settings.configdata['http_auth']['password']
+      use Rack::Auth::Basic, 'Puppet Private Access' do |user, pass|
+        user == settings.configdata['http_auth']['username'] &&
+          pass == settings.configdata['http_auth']['password']
       end
 
       get '/logout' do
@@ -60,10 +64,11 @@ module HieravizApp
 
       helpers do
         def check_authorization
-          if !session['access_token']
-            session[:access_token] = settings.configdata['http_auth']['access_token']
+          http_auth = settings.configdata['http_auth']
+          unless session['access_token']
+            session[:access_token] = http_auth['access_token']
           end
-          settings.configdata['http_auth']['username']
+          http_auth['username']
         end
       end
 
@@ -72,24 +77,32 @@ module HieravizApp
       set :oauth, Hieraviz::AuthGitlab.new(settings.configdata['gitlab_auth'])
 
       helpers do
-
         def check_authorization
-          if !session['access_token']
-            redirect settings.oauth.login_url(request)
-          else
-            session_info = Hieraviz::Store.get(session['access_token'], settings.configdata['session_renew'])
-            if !session_info
-              if !settings.oauth.authorized?(session['access_token'])
-                flash[:fatal] = "Sorry you are not authorized to read puppet repo on gitlab."
-                redirect '/'
-              else
-                Hieraviz::Store.set session['access_token'], settings.oauth.user_info(session['access_token'])
-                session_info = Hieraviz::Store.get(session['access_token'], settings.configdata['session_renew'])
-              end
-            end
+          if session_info['username']
             session_info['username']
+          else
+            access_token = session['access_token']
+            oauth = settings.oauth
+            redirect oauth.login_url(request) unless access_token
+            return init_session(oauth, access_token) if oauth.authorized?(access_token)
+            sorry
           end
         end
+
+        def session_info
+          settings.store.get session['access_token'], settings.configdata['session_renew']
+        end
+
+        def init_session(oauth, access_token)
+          user_info = oauth.user_info(access_token)
+          settings.store.set access_token, user_info
+          user_info['username']
+        end
+
+        def sorry
+          flash[:fatal] = 'Sorry you are not authorized to read puppet repo on gitlab.'
+          redirect '/'
+        end
       end
 
       get '/login' do
@@ -99,8 +112,8 @@ module HieravizApp
       get '/logged-in' do
         access_token = settings.oauth.access_token(request, params[:code])
         session[:access_token] = access_token.token
-        Hieraviz::Store.set access_token.token, settings.oauth.user_info(access_token.token)
-        flash['info'] = "Successfully authenticated with the server"
+        settings.store.set access_token.token, settings.oauth.user_info(access_token.token)
+        flash['info'] = 'Successfully authenticated with the server'
         redirect '/'
       end
 
@@ -109,15 +122,13 @@ module HieravizApp
         redirect '/'
       end
 
-    else
     end
 
     get '/' do
       if settings.basepaths
         redirect "/#{File.basename(settings.configdata['basepath'])}"
       else
-        @username = get_username
-        hieracles_config = prepare_config(nil)
+        @username = username
         erb :home
       end
     end
@@ -126,7 +137,7 @@ module HieravizApp
       @username = check_authorization
       hieracles_config = prepare_config(base)
       @nodes = Hieracles::Registry.nodes(hieracles_config)
-      erb :nodes 
+      erb :nodes
     end
 
     get %r{^/?([-_\.a-zA-Z0-9]+)?/farms} do |base|
@@ -137,37 +148,33 @@ module HieravizApp
     end
 
     get %r{^/?([-_\.a-zA-Z0-9]+)?/modules} do |base|
+      prepare_config(base)
       @username = check_authorization
-      hieracles_config = prepare_config(base)
       erb :modules
     end
 
     get %r{^/?([-_\.a-zA-Z0-9]+)?/resources} do |base|
+      prepare_config(base)
       @username = check_authorization
-      hieracles_config = prepare_config(base)
       erb :resources
     end
 
     get %r{^/?([-_\.a-zA-Z0-9]+)?/user} do |base|
+      prepare_config(base)
       @username = check_authorization
-      hieracles_config = prepare_config(base)
-      if session[:access_token]
-        @userinfo = get_userinfo 
-      else
-        @userinfo = {}
-      end
+      @userinfo = session[:access_token] ? userinfo : {}
       erb :user
     end
 
     get %r{^/([-_\.a-zA-Z0-9]+)$} do |base|
-      @username = get_username
-      hieracles_config = prepare_config(base)
+      prepare_config(base)
+      @username = username
       erb :home
     end
 
     # debug pages --------------------
     # get '/store' do
-    #   # Hieraviz::Store.set 'woot', 'nada'
+    #   # settings.store.set 'woot', 'nada'
     #   erb :store
     # end
     # error 401 do
@@ -180,10 +187,9 @@ module HieravizApp
     # debug pages --------------------
 
     not_found do
-      @username = get_username
+      @username = username
       erb :not_found, layout: :_layout
     end
 
-
   end
 end

data/config.ru

@@ -2,7 +2,5 @@ require 'rubygems'
 require 'sinatra'
 require File.expand_path '../app/main.rb', __FILE__
 
-run Rack::URLMap.new({
-  '/' => HieravizApp::Web,
-  '/v1' => HieravizApp::ApiV1
-})
+run Rack::URLMap.new('/' => HieravizApp::Web,
+                     '/v1' => HieravizApp::ApiV1)

data/lib/hieraviz/auth_gitlab.rb

@@ -1,50 +1,53 @@
 require 'oauth2'
+require 'hieraviz/utilities'
 
 module Hieraviz
+  # class to manage gitlab oauth2 connection and authorization checks
   class AuthGitlab
+    include Utilities
 
     def initialize(settings)
-      @@client ||= OAuth2::Client.new(
-        settings['application_id'], 
-        settings['secret'], 
-        :site => settings['host']
-        )
       @settings = settings
+      @client = OAuth2::Client.new(
+        @settings['application_id'],
+        @settings['secret'],
+        site: @settings['host']
+      )
     end
 
     def access_token(request, code)
-      @@client.auth_code.get_token(code, :redirect_uri => redirect_uri(request.url))
+      @client.auth_code.get_token(code, redirect_uri: redirect_uri(request.url))
     end
 
     def get_response(url, token)
-      a_token = OAuth2::AccessToken.new(@@client, token)
+      a_token = OAuth2::AccessToken.new(@client, token)
       begin
         JSON.parse(a_token.get(url).body)
-      rescue Exception => e
-        { 'error' => JSON.parse(e.message.split(/\n/)[1])['message'] }
+      rescue StandardError => error
+        { 'error' => JSON.parse(error.message.split(/\n/)[1])['message'] }
       end
     end
 
-    def redirect_uri(url)
-      uri = URI.parse(url)
-      uri.path = '/logged-in'
-      uri.query = nil
-      uri.fragment = nil
-      uri.to_s
-    end
-
     def login_url(request)
-      @@client.auth_code.authorize_url(:redirect_uri => redirect_uri(request.url))
+      @client.auth_code.authorize_url(redirect_uri: redirect_uri(request.url))
     end
 
     def authorized?(token)
-      if @settings['resource_required']
-        resp = get_response(@settings['resource_required'], token)
-        if resp['error'] ||
-           (resp[@settings['required_response_key']] &&
-           resp[@settings['required_response_key']] != resp[@settings['required_response_value']])
-          return false
-        end
+      resource_required = @settings['resource_required']
+      if resource_required
+        return check_authorization(resource_required, token)
+      end
+      true
+    end
+
+    def check_authorization(resource_required, token)
+      resp = get_response(resource_required, token)
+      resp_required_response_key = resp[@settings['required_response_key']].to_s
+      resp_required_response_value = @settings['required_response_value'].to_s
+      if resp['error'] || 
+        ( resp_required_response_key && 
+          resp_required_response_key != resp_required_response_value)
+        return false
       end
       true
     end

data/lib/hieraviz/config.rb

@@ -1,18 +1,18 @@
 module Hieraviz
+  # module to manage parsing and holding of configuration variables
   module Config
-    extend self
-
     def load
       @_config = YAML.load_file(configfile)
     end
 
     def configfile
-      root_path(ENV['HIERAVIZ_CONFIG_FILE'] || File.join("config", "hieraviz.yml"))
+      root_path(ENV['HIERAVIZ_CONFIG_FILE'] || File.join('config', 'hieraviz.yml'))
     end
 
     def basepaths
-      if @_config && @_config['basepath_dir']
-        Dir.glob(root_path(@_config['basepath_dir'])).map { |p| File.expand_path(p) }
+      basepath_dir = @_config['basepath_dir']
+      if @_config && basepath_dir
+        Dir.glob(root_path(basepath_dir)).map { |path| File.expand_path(path) }
       end
     end
 
@@ -27,6 +27,7 @@ module Hieraviz
         File.join(root, path)
       end
     end
-
+    
+    module_function :load, :configfile, :basepaths, :root, :root_path
   end
 end

data/lib/hieraviz/facts.rb

@@ -1,10 +1,11 @@
 module Hieraviz
+  # class for storage and retrieval of customized facts that can overlay hiera facts
   class Facts
 
     def initialize(tmpdir, base, node, user)
       @filename = File.join(tmpdir, "#{base}__#{node}__#{user}")
     end
-    
+
     def exist?
       File.exist? @filename
     end
@@ -12,11 +13,13 @@ module Hieraviz
     def read
       if exist?
         Marshal.load(File.binread(@filename))
+      else
+        {}
       end
     end
-    
+
     def write(data)
-      File.open(@filename, 'wb') {|f| f.write(Marshal.dump(data)) }
+      File.open(@filename, 'wb') { |file| file.write(Marshal.dump(data)) }
     end
 
     def remove

data/lib/hieraviz/puppetdb.rb

@@ -1,4 +1,5 @@
 module Hieraviz
+  # wrapper class to call hieracles puppetdb class
   class Puppetdb
 
     def initialize(config)

data/lib/hieraviz/store.rb

@@ -1,25 +1,37 @@
 module Hieraviz
-  module Store
-    extend self
+  class Store
+
+    def initialize(storedir)
+      @tmpdir = init_tmpdir(storedir)
+    end
 
     def data
-      @_data ||= Hash.new
+      @_data ||= {}
+    end
+
+    def clear_data
+      @_data = {}
+      data
     end
 
     def set(key, value)
-      File.open(tmpfile(key), 'w') do |f|
-        f.print Marshal::dump(value)
+      File.open(tmpfile(key), 'w') do |file|
+        file.print Marshal.dump(value)
       end
       data[key] = value
     end
 
-    def get(key, expiration=false)
-      f = tmpfile(key)
-      if File.exist?(f) && expiration && expired?(f, expiration)
-        File.unlink(f)
-      end
-      if File.exist?(f)
-        data[key] ||= Marshal::load(File.read(f).chomp)
+    def get(key, expiration)
+      file = tmpfile(key)
+      if File.exist?(file)
+        if expiration && expired?(file, expiration)
+          File.unlink(file)
+          clear_data
+        else
+          data[key] ||= Marshal.load(File.read(file).chomp)
+        end
+      else
+        clear_data
       end
     end
 
@@ -28,19 +40,14 @@ module Hieraviz
     end
 
     def tmpfile(name)
-      File.join tmpdir, name.gsub(/[^a-z0-9]/,'')
-    end
-
-    def tmpdir
-      @_tmpdir ||= init_tmpdir 
+      File.join @tmpdir, name.gsub(/[^a-z0-9]/, '')
     end
 
-    def init_tmpdir
-      config = Hieraviz::Config.load
-      tmp = config['tmpdir'] || '/tmp'
+    def init_tmpdir(storedir)
+      tmp = storedir || '/tmp'
       begin
         FileUtils.mkdir_p(tmp) unless Dir.exist?(tmp)
-      rescue Exception => e
+      rescue
         tmp = '/tmp'
       end
       tmp

data/lib/hieraviz/utilities.rb

@@ -0,0 +1,14 @@
+module Hieraviz
+  # Convenience methods used by various other classes
+  module Utilities
+    
+    def redirect_uri(url)
+      uri = URI.parse(url)
+      uri.path = '/logged-in'
+      uri.query = nil
+      uri.fragment = nil
+      uri.to_s
+    end
+
+  end
+end

data/lib/hieraviz.rb

@@ -1,10 +1,10 @@
 require 'hieracles'
-require "hieraviz/version"
-require "hieraviz/config"
-require "hieraviz/store"
-require "hieraviz/facts"
-require "hieraviz/auth_gitlab"
-require "hieraviz/puppetdb"
+require 'hieraviz/version'
+require 'hieraviz/config'
+require 'hieraviz/store'
+require 'hieraviz/facts'
+require 'hieraviz/auth_gitlab'
+require 'hieraviz/puppetdb'
 
 module Hieraviz
   # Your code goes here...