bigsister 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a50534c33ddfd8a24515e6541a2f253e2e85f0d01386b5dd7ed1700be3aa45a8
-  data.tar.gz: 7079aa5b42b2b1d8ebb3e79a4636ff52b43b7631710fb9275f2c08b69410fe70
+  metadata.gz: 801cec260afc76e68534a6eb2a927af3ded0e4a3127b87288cc7129ca11fb643
+  data.tar.gz: ee112f0f35496f9c96271e57774c9cbb814a704d2d97f5bba7f59b156fbf99b3
 SHA512:
-  metadata.gz: '08b2de6a443be21dbae3cb96d06782a5847d63ce5df45818a5df2badc6032a2fa0a47827e39f5d3703e64cd0fec5c3d2dc083ccf338c3ade69805ad3daaf466c'
-  data.tar.gz: 3d04fccc1494aa208549c2cc65a0c2acf76f8317b70cb131adb1b8e67589bcfce129b76277ca2b12d8e0b820ebabc2804271b6251842dfd3eac80dba099da424
+  metadata.gz: cab071a5a1faf95f92221df55e7bcef07b75ee8220d241572a4fc624a2b150d2260882802ed2d1e8032e0ac54974ee72d18bd4f188968080b5d70d3b8f7699c0
+  data.tar.gz: 82720dfdfcb3d29abbd233f8ad0c2a51a6b2e0e3b12b289d485366c3a206baf6bc9712f01cdbb632fb747f1eabb88f8d5852aab25d0c73b214228ab39b2ae0f4

data/.bigsister.yml

@@ -0,0 +1,49 @@
+monitor:
+  - type: local
+    path: /Users/paul
+  - type: springcm
+    path: /Human Resources Records
+    credentials:
+      client_id: client_id
+      client_secret: client_secret
+      data_center: data_center
+generate:
+  - type: csv
+    path: ./detail.csv
+    format: detail
+    mode: write
+    include:
+      - directories
+      - files
+    columns:
+      - title: Timestamp
+        type: timestamp
+      - title: Path
+        type: path
+      - title: File Size
+        type: size
+      - title: File Type
+        type: type
+      - title: Created
+        type: created_at
+      - title: Modified
+        type: modified_at
+      - title: Customer
+        type: literal
+        value: KHSD
+  - type: csv
+    path: ./summary.csv
+    format: summary
+    mode: append
+    include:
+      - directories
+      - files
+    columns:
+      - title: Timestamp
+        type: timestamp
+      - title: File Count
+        type: file_count
+      - title: Directory Count
+        type: directory_count
+      - title: File Size
+        type: file_size

data/.travis.yml

@@ -5,3 +5,11 @@ cache: bundler
 rvm:
   - 2.5.1
 before_install: gem install bundler -v 2.0.2
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/GHANGELOG.md

@@ -4,4 +4,10 @@ All notable changes to BigSister will be documented in this file.
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/paulholden2/bigsister/compare/0.1.0...HEAD
+## [0.1.1] - Nov 8, 2019
+### Added
+* Basic Application object
+* CLI tool
+
+[Unreleased]: https://github.com/paulholden2/bigsister/compare/0.1.1...HEAD
+[0.1.1]: https://github.com/paulholden2/bigsister/releases/tag/0.1.1

data/README.md

@@ -1,5 +1,7 @@
 # BigSister
 
+[![Build Status](https://travis-ci.org/paulholden2/bigsister.svg?branch=master)](https://travis-ci.org/paulholden2/bigsister) [![Maintainability](https://api.codeclimate.com/v1/badges/5c5e63e8a1c0f3830129/maintainability)](https://codeclimate.com/github/paulholden2/bigsister/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/5c5e63e8a1c0f3830129/test_coverage)](https://codeclimate.com/github/paulholden2/bigsister/test_coverage)
+
 A gem for generating reports on the contents of local and remote files for monitoring purposes. Above-board monitoring purposes.
 
 ## Installation
@@ -21,7 +23,7 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-$> bigsister
+$ bigsister
 ```
 
 ## Development

data/bigsister.gemspec

@@ -28,8 +28,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "springcm-sdk", "~> 0.3"
+  spec.add_dependency "os", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.17"
 end

data/exe/bigsister

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bigsister"
+require "bigsister/application"
+require "springcm-sdk"
+
+begin
+  application = BigSister::Application.new
+  application.run
+rescue BigSister::Error => e
+  puts "ERROR: #{e.message}"
+rescue Springcm::Error => e
+  puts e.inspect
+end

data/lib/bigsister.rb

@@ -2,5 +2,22 @@ require "bigsister/version"
 
 module BigSister
   class Error < StandardError
+    def initialize(exception)
+      @exception = exception
+    end
+
+    def message
+      @exception
+    end
+
+    def inspect
+      %(#<#{self.class} @exception=#{@exception}>)
+    end
+  end
+
+  class NoConfigurationFound < Error
+    def initialize(checked_paths)
+      super("No configuration files found. Looked in: #{checked_paths.join(', ')}")
+    end
   end
 end

data/lib/bigsister/application.rb

@@ -0,0 +1,32 @@
+require "os"
+require "yaml"
+require "bigsister/configuration"
+
+module BigSister
+  class Application
+    DEFAULT_CONFIG_PATHS = ["./.bigsister.yml", "~/.bigsister/config.yml"].freeze
+
+    attr_reader :config
+
+    def initialize(opts = {})
+      @config_paths = opts[:config_paths] || DEFAULT_CONFIG_PATHS
+
+      load_config!
+    end
+
+    def run
+    end
+
+    private
+
+    def load_config!
+      yaml = @config_paths.map { |path|
+        File.exists?(path) && YAML.load(File.open(path).read)
+      }.select(&:itself).first
+      if yaml.nil?
+        raise BigSister::NoConfigurationFound.new(@config_paths)
+      end
+      @config = Configuration.new(yaml)
+    end
+  end
+end

data/lib/bigsister/configuration.rb

@@ -0,0 +1,53 @@
+require "bigsister/monitors/local"
+require "bigsister/monitors/springcm"
+
+module BigSister
+  class Configuration
+    MONITOR_TYPES = %w(local springcm).freeze
+
+    attr_reader :monitors
+
+    def initialize(data)
+      @monitors = []
+      @config_errors = []
+
+      load_monitoring(data)
+    end
+
+    def valid?
+      @config_errors.empty?
+    end
+
+    private
+
+    def load_monitoring(data)
+      @monitoring = data.fetch("monitor", [])
+      if @monitoring.empty?
+        config_error("No monitoring locations configured")
+      end
+      @monitoring.each_with_index { |location, i|
+        # Validate monitoring type
+        type = location.fetch("type", nil)
+        if type.nil?
+          config_error("No monitoring type specified for location #{i}")
+        elsif !MONITOR_TYPES.include?(type)
+          config_error("Invalid monitoring type specified for location #{i}")
+        else
+          @monitors.push(load_monitor(type, location, i))
+        end
+      }
+    end
+
+    def load_monitor(type, location, i)
+      if type == "local"
+        BigSister::LocalMonitor.new(location, i)
+      elsif type == "springcm"
+        BigSister::SpringcmMonitor.new(location, i)
+      end
+    end
+
+    def config_error(message)
+      @config_errors.push(message)
+    end
+  end
+end

data/lib/bigsister/monitor.rb

@@ -0,0 +1,14 @@
+module BigSister
+  class Monitor
+    def initialize(location, id)
+      @location = location
+      @id = id
+    end
+
+    def summary
+    end
+
+    def detail
+    end
+  end
+end

data/lib/bigsister/monitors/local.rb

@@ -0,0 +1,6 @@
+require "bigsister/monitor"
+
+module BigSister
+  class LocalMonitor < BigSister::Monitor
+  end
+end

data/lib/bigsister/monitors/springcm.rb

@@ -0,0 +1,6 @@
+require "bigsister/monitor"
+
+module BigSister
+  class SpringcmMonitor < BigSister::Monitor
+  end
+end

data/lib/bigsister/version.rb

@@ -1,3 +1,3 @@
 module BigSister
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bigsister
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Paul Holden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2019-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: springcm-sdk
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,13 +80,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
 description: 
 email:
 - pholden@stria.com
-executables: []
+executables:
+- bigsister
 extensions: []
 extra_rdoc_files: []
 files:
+- ".bigsister.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -84,7 +114,13 @@ files:
 - bigsister.gemspec
 - bin/console
 - bin/setup
+- exe/bigsister
 - lib/bigsister.rb
+- lib/bigsister/application.rb
+- lib/bigsister/configuration.rb
+- lib/bigsister/monitor.rb
+- lib/bigsister/monitors/local.rb
+- lib/bigsister/monitors/springcm.rb
 - lib/bigsister/version.rb
 homepage: https://github.com/paulholden2/bigsister
 licenses: