grafana_annotations 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b8f824ed8c6d9b1a0c170564819962895aa7b1e28b205943f10c50747d60742
-  data.tar.gz: 3f8244937b2ee09e8f1d7eec67f553f51c0165257f68bcabe70d1c45783a859b
+  metadata.gz: e267c0a1a55c4ef041a2265d4b0f5c196cfef80e45a99c94d959bc053bbc5c17
+  data.tar.gz: b0803367808f76bd1d841bb38992e240fc6a3a6e0bd3bb2941289503fa842d91
 SHA512:
-  metadata.gz: d4aa25b46e25cb0bb08d60459c3fbbdfaf11f8a19a2c5f64e3e0c039eeb7276d5907868748bfdc15504f1a8c723cd1c7862daf672a24436f166af63f516ce238
-  data.tar.gz: 20037e0fbd7e636c1b341991e270ef0c9808de853e9e79b13480a3b926aa2259a1e2895170d217d4be63f64e72e887796946dd1dac8d40e889af328c98e15473
+  metadata.gz: bdccb1742d90c8c6a48038ca8a9f2e1dcd3b7c1bdb13ebe069edcfcca6c029963317647ed31fa56b4dfa9acef63105dd70dfe96f5493c80009567b78b5f1ab1e
+  data.tar.gz: c28f18dfb730fabc2d170c3b2afad4daca5c06c2870920b3acf4153c72a7eab878988fc2e10bb30a221f5270369ba33b32ff6ad6857abf67d9e64a8afa227145

data/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.1.0
+current_version = 0.1.1
 commit = True
 tag = True
 tag_name = {new_version}
@@ -10,5 +10,5 @@ message = bump version {current_version} → {new_version}
 [bumpversion:file:README.md]
 
 [bumpversion:file:Gemfile.lock]
-search = http_health_check ({current_version})
-replace = http_health_check ({new_version})
+search = grafana_annotations ({current_version})
+replace = grafana_annotations ({new_version})

data/.github/workflows/ci.yml

@@ -15,10 +15,13 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
+        # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+        # change this to (see https://github.com/ruby/setup-ruby#versioning):
+        # uses: ruby/setup-ruby@v1
+        uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
         with:
-          bundler-cache: true
-          ruby-version: ${{ matrix.ruby }}
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
       - name: Run all tests
         run: bundle exec rspec
       - name: Run rubocop

data/.gitignore

@@ -7,3 +7,4 @@
 /spec/reports/
 /tmp/
 /.idea
+grafana_annotations-*.gem

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG.md
 
+## 0.1.1 (2022-09-02)
+
+Features:
+
+- use default value for `GrafanaAnnotations::Annotation.time`
+- add `GrafanaAnnotations#configured?` for ready-state probing
+
+
 ## 0.1.0 (2022-07-21)
 
 Features:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grafana_annotations (http_health_check (0.1.0))
+    grafana_annotations (0.1.1)
       dry-initializer
       dry-monads
       dry-struct
@@ -11,25 +11,25 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
     concurrent-ruby (1.1.10)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
+    crack (0.4.5)
+      rexml
     diff-lcs (1.5.0)
-    dry-configurable (0.12.0)
+    dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5.0)
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.5.0)
+    dry-core (0.6.0)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
     dry-inflector (0.2.0)
     dry-initializer (3.0.4)
-    dry-logic (1.1.0)
+    dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
     dry-monads (1.3.5)
@@ -40,24 +40,42 @@ GEM
       dry-core (~> 0.5, >= 0.5)
       dry-types (~> 1.5)
       ice_nine (~> 0.11)
-    dry-types (1.5.0)
+    dry-types (1.5.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
       dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    faraday (1.3.0)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
       faraday-net_http (~> 1.0)
-      multipart-post (>= 1.2, < 3)
-      ruby2_keywords
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
     faraday-net_http (1.0.1)
-    hashdiff (0.4.0)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    hashdiff (1.0.1)
     ice_nine (0.11.2)
-    multipart-post (2.1.1)
+    multipart-post (2.2.3)
     parallel (1.22.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.6)
+    public_suffix (4.0.7)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.5.0)
@@ -87,16 +105,16 @@ GEM
     rubocop-ast (1.17.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.4)
-    safe_yaml (1.0.5)
+    ruby2_keywords (0.0.5)
     unicode-display_width (1.8.0)
-    webmock (3.3.0)
-      addressable (>= 2.3.6)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   x86_64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   grafana_annotations!

data/README.md

@@ -1,5 +1,7 @@
 # GrafanaAnnotations
 
+[![Gem Version](https://badge.fury.io/rb/grafana_annotations.svg)](https://badge.fury.io/rb/grafana_annotations)
+
 Add custom annotations to grafana from your ruby application.
 
 ## Installation
@@ -7,7 +9,7 @@ Add custom annotations to grafana from your ruby application.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'grafana_annotations', '~> 0.1.0'
+gem 'grafana_annotations', '~> 0.1.1'
 ```
 
 And then execute:
@@ -45,7 +47,7 @@ end
 
 ```ruby
 result = GrafanaAnnotations.default_api_client.create(
-  time: GrafanaAnnotations::Utils::Time.now_ms, # timestamp in milliseconds (integer)
+  time: GrafanaAnnotations::Utils::Time.now_ms, # timestamp in milliseconds (integer), optional
   tags: [:my_app, :my_event],
   text: "Boom!"
 )
@@ -64,6 +66,7 @@ end
 ### Rake tasks instrumentation
 
 Just require `grafana_annotations/rake` within your Rakefile and annotation request will be sent for every rake task.
+
 ```ruby
 # Rakefile
 require 'grafana_annotations/rake'

data/lib/grafana_annotations/annotation.rb

@@ -4,7 +4,7 @@ module GrafanaAnnotations
   class Annotation < Dry::Struct
     attribute? :dashboardUID, Types::Strict::String.optional
     attribute? :panelId, Types::Strict::String.optional
-    attribute :time, Types::Strict::Integer
+    attribute(:time, Types::Strict::Integer.default { GrafanaAnnotations::Utils::Time.now_ms })
     attribute? :timeEnd, Types::Strict::Integer
     attribute :tags, Types::Strict::Array.of(Types::Coercible::String)
     attribute :text, Types::Strict::String

data/lib/grafana_annotations/rake.rb

@@ -4,7 +4,7 @@ module GrafanaAnnotations
   module Rake
     module Task
       def invoke(*args)
-        return super unless GrafanaAnnotations.config
+        return super unless GrafanaAnnotations.configured?
 
         text = [GrafanaAnnotations.config.rake_text_prefix, name].join(' ')
         text += " #{args.inspect}" unless args.empty?

data/lib/grafana_annotations/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrafanaAnnotations
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/grafana_annotations.rb

@@ -29,16 +29,22 @@ module GrafanaAnnotations
       raise ConfigurationError, e.message
     end
 
+    def configured?
+      config.is_a? GrafanaAnnotations::Config
+    end
+
     def default_api_client
       @default_api_client ||= begin
-        raise ConfigurationError, 'todo' unless config
+        unless configured?
+          raise ConfigurationError, 'Use GrafanaAnnotations.configure in initializer (see https://github.com/SberMarket-Tech/grafana_annotations#configuration)'
+        end
 
         new_api_client({})
       end
     end
 
     def new_api_client(opts)
-      return ApiClient.new(opts) unless config
+      return ApiClient.new(opts) unless configured?
 
       ApiClient.new(
         opts.merge(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grafana_annotations
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - SberMarket Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer