inventarium 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dce2dfe30e6634640b0e8248c87b45a5de34ef9c41d1c524a63f2d6bd66a62f
-  data.tar.gz: 8a66c2006593af39169c6ba0ab7c144fa05d065eccf05d28f9bca506d3d19caf
+  metadata.gz: 395db22e4f7711b1376ce7a3a6b830813143fd4c06fc9f2a96675d0d73cf6200
+  data.tar.gz: 23468bbeb716770cd8029ffb3ac4d0e00e8710641cff9b1eb86535076019790a
 SHA512:
-  metadata.gz: 72916d7d94596cf7caa35bb87388d841ef825f50ba49f0574029d55e08ed604ec6d1b737a5ef29788056f6e21b5b2a8c8b0e02cb7779a59b907654317cf23df3
-  data.tar.gz: cb83ab763a0e1792d427c39649f2f28b3c0966bb88f33a848774667c6ef9ccf01afd2dc9d91dec34f349143a5582d337b0689ae89263e0a3fb699b77c6b1c9e1
+  metadata.gz: 7606c0b74c51656bad562b3ee9dc465793232da3e2b56a99753427e4f5249c65ecb5458b4823ab4e892709c8f935077e06e405cf81c6b41eaeda450ef482ae7e
+  data.tar.gz: d9b2613a387fc59e67b3e39b28258fb39f3ab0a3dbb5abfbdc2c243f34989d18e25283cc9efef213ec406c2af57a7a935be65f0761f7734a8baa97a94d66f64d

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    inventarium (0.2.0)
+    inventarium (0.3.0)
       dry-cli (~> 0.4)
       pastel
       tty-progressbar
+      tty-prompt
 
 GEM
   remote: https://rubygems.org/
@@ -16,6 +17,7 @@ GEM
       concurrent-ruby (~> 1.0)
     equatable (0.6.1)
     json (2.3.0)
+    necromancer (0.5.1)
     pastel (0.7.4)
       equatable (~> 0.6)
       tty-color (~> 0.5)
@@ -48,8 +50,17 @@ GEM
       tty-cursor (~> 0.7)
       tty-screen (~> 0.7)
       unicode-display_width (~> 1.6)
+    tty-prompt (0.21.0)
+      necromancer (~> 0.5.0)
+      pastel (~> 0.7.0)
+      tty-reader (~> 0.7.0)
+    tty-reader (0.7.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
+      wisper (~> 2.0.0)
     tty-screen (0.7.1)
     unicode-display_width (1.7.0)
+    wisper (2.0.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -1,5 +1,19 @@
 # Inventarium CLI
 
+## Instalation
+
+Requirements:
+
+- Ruby version: `2.5.0` (working with default macOS version)
+
+```
+gem install inventarium
+```
+
+## Usage
+
+- `inventarium init` - generate new empty `service.yaml` file
+- `inventarium push path/to/service.yaml` - push service information to [inventarium app](https://inventarium.io)
 
 ## Copyright
 

data/inventarium.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "dry-cli", "~> 0.4"
   spec.add_runtime_dependency "tty-progressbar"
+  spec.add_runtime_dependency "tty-prompt"
   spec.add_runtime_dependency "pastel"
 
   spec.add_development_dependency "bundler"

data/lib/inventarium/cli.rb

@@ -1,4 +1,5 @@
 require "dry/cli"
+require_relative "./cli/template_generator"
 require_relative "./cli/version"
 require_relative "./cli/init"
 require_relative "./cli/push"

data/lib/inventarium/cli/init.rb

@@ -1,3 +1,5 @@
+require "tty-prompt"
+
 module Inventarium
   module CLI
     class Init < Dry::CLI::Command
@@ -9,20 +11,35 @@ module Inventarium
         "order_service.yaml # Generate order_service.yml in root folder"
       ]
 
+      CLASSIFICATION_VALUES = %w[critical normal internal experiment]
+      STATUS_VALUES = %w[adopt hold trial in_development]
+
       def call(args: [], **)
-        dir = args.first || '.'
+        dir = args.first || './service.yaml'
+        result = base_service_information
 
         pastel = Pastel.new
         printf "Generating a new service.yaml\t\t"
 
-        FileUtils.cp(template_file_path, dir)
+        TemplateGenerator.new.call(dir: dir, payload: result)
+
         puts "[#{pastel.green('DONE')}]"
       end
 
     private
 
-      def template_file_path
-        File.expand_path(File.dirname(__FILE__) +  "/templates/service.yaml")
+      def base_service_information
+        prompt = TTY::Prompt.new
+        name = prompt.ask('A name of the service:', required: true)
+
+        key = prompt.ask("A uniq key for service (you can use only chars, integers, '_' and '-'):", required: true) do |q|
+          q.validate(/\A[a-zA-Z0-9_-]+\Z/, "Invalid key value, please use only chars, integers and '-'")
+        end
+
+        classification = prompt.select("Choose service classification", CLASSIFICATION_VALUES, symbols: {marker: '>'})
+        status = prompt.select("Choose service status", STATUS_VALUES, symbols: {marker: '>'})
+
+        { name: name, key: key, classification: classification, status: status }
       end
     end
   end

data/lib/inventarium/cli/push.rb

@@ -2,6 +2,7 @@ require 'tty-progressbar'
 require 'net/http'
 require 'yaml'
 require 'json'
+require 'pp'
 
 module Inventarium
   module CLI
@@ -29,19 +30,25 @@ module Inventarium
 
         bar.advance(10)
 
+        pastel = Pastel.new
+
         case response.code
         when '200'
-          pastel = Pastel.new
           puts "[#{pastel.green('DONE')}]"
-        when '422'
-          pastel = Pastel.new
+
+          exit(0) # success exist
+        when '401' #  Unauthorized
           puts "[#{pastel.red('FAIL')}] #{response.body}"
-        when '500'
-          pastel = Pastel.new
+        when '403' #  Forbidden
           puts "[#{pastel.red('FAIL')}] #{response.body}"
+        when '422' # invalid data
+          puts "[#{pastel.red('FAIL')}]"
+          pp JSON.parse(response.body)
+        when '500'
+          puts "[#{pastel.red('FAIL')}] Service error, please try later or create an issue in https://github.com/inventarium-org/core"
         end
 
-        # puts "Push a new service.yml file from '#{dir}' directory"
+        exit(1)
       end
 
     private

data/lib/inventarium/cli/template_generator.rb

@@ -0,0 +1,20 @@
+require 'erb'
+
+module Inventarium
+  module CLI
+    class TemplateGenerator
+      def call(dir:, payload:)
+        template = File.read(template_file_path)
+        result = ERB.new(template).result(binding)
+
+        File.open(dir, 'w') { |f| f.write(result) }
+      end
+
+    private
+
+      def template_file_path
+        File.expand_path(File.dirname(__FILE__) +  "/templates/service.yaml.erb")
+      end
+    end
+  end
+end

data/lib/inventarium/cli/templates/service.yaml.erb

@@ -0,0 +1,64 @@
+version: v0
+
+# You need to provide only name and key fields, everything else can be empty
+# For example, if you don't have documentation or environments you can add it later
+
+# required
+name: <%= payload[:name] %>
+# required, should be unique for each service
+key: <%= payload[:key] %>
+description:
+languages:
+  -
+repository_link:
+tags:
+  -
+
+owner:
+  team_or_developer_name:
+  slack_channel:
+
+service:
+  # optional, can be (critical | normal | internal | experiment)
+  classification: <%= payload[:classification] %>
+  # optional, can be (adopt | hold | trial | in_development)
+  status: <%= payload[:status] %>
+
+docs:
+  api:
+  maintenance:
+  domain:
+
+# You can add any count of environments and you can use any names instead production, like stage, demo, etc
+environments:
+  production:
+    url:
+    healthcheck_url:
+    logs_url:
+    error_tracker_url:
+    tags:
+      - test
+      - specific gateway
+    monitoring:
+      # You can use any key-value objects here, like new_relic, grafana, etc
+      something: 
+
+operations:
+  ci_build_url:
+
+communications:
+    # type is reqired, can be (http | rpc | graphql | event-producer | event-consumer)
+  - type:
+    # reqired, can be anything like (service key | kafka | rabbitmq | etc)
+    target:
+    # optional, can be (critical | uncritical)
+    criticality:
+    # optional list, can be (topic name | queue name | rpc resource | rest resource | gqlschema name)
+    resource:
+      -
+    # optional
+    custom_data:
+      # can be anything
+      # events:
+      #   - test-event
+      # version: 2

data/lib/inventarium/version.rb

@@ -1,3 +1,3 @@
 module Inventarium
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inventarium
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Anton Davydov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-12 00:00:00.000000000 Z
+date: 2020-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +128,8 @@ files:
 - lib/inventarium/cli.rb
 - lib/inventarium/cli/init.rb
 - lib/inventarium/cli/push.rb
-- lib/inventarium/cli/templates/service.yaml
+- lib/inventarium/cli/template_generator.rb
+- lib/inventarium/cli/templates/service.yaml.erb
 - lib/inventarium/cli/version.rb
 - lib/inventarium/version.rb
 homepage: https://inventarium.io

data/lib/inventarium/cli/templates/service.yaml

@@ -1,47 +0,0 @@
-version: v0
-
-# You need to provide only name and key fields, everything else can be empty
-# For example, if you don't have documentation or environments you can add it later
-
-# required
-name: Service
-# required, should be unique for each service
-key: service
-description:
-languages:
-  -
-repository_link:
-tags:
-  -
-
-owner:
-  team_or_developer_name:
-  slack_channel:
-
-service:
-  # optional, can be (critical | normal | internal | expiriment)
-  classification:
-  # optional, can be (adopt | hold | trial | in development)
-  status:
-
-docs:
-  api:
-  maintenance:
-  domain:
-
-# You can add any count of environments and you can use any names instead production, like stage, demo, etc
-environments:
-  production:
-    url:
-    healthcheck_url:
-    logs_url:
-    error_traker_url:
-    tags:
-      - test
-      - specific gateway
-    monitoring:
-      # You can use any key-value objects here, like new_relic, grafana, etc
-      something: 
-
-operations:
-  ci_build_url: