nrql2nerd 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddaca5d74da000d97860a064875d2409877798267416701bc9fbb236ae14e2a5
-  data.tar.gz: 672ed206989168c77f0fe1064c4696568e49d1b9476108969b63f63d457bc8ec
+  metadata.gz: 55cbb1993b307f9359b4807038edafe404b43e8dedbb5bffd4775d25b499bcaf
+  data.tar.gz: db521f81734c56040b140f59390211b40ab0ef1532b38d33203d76f3852722a5
 SHA512:
-  metadata.gz: c01f9e36d7dfdfb08b75dbe25a410ecaed1ed58d12aead8bb83b4e6366c42df21e79fb5c9548740b375a50892eef8435aeb96d7376858b0eefdc7b3d4d303893
-  data.tar.gz: d51dfe7b49a9f0de1f76b388ea3b4f11651982d173781665f7cf474ad0c622f51ad1e643118c53b93c51ad6decdb8b21c5fae4b46c5f1f633996301f32fdd519
+  metadata.gz: '0976bf74faa4920520e35ad12167698b4abb02af8aa6d5a1a78cbd238451561a2ef5f870030177f3f7667ace1793a2f7d99b688db409faa12bd9d216dae4156f'
+  data.tar.gz: daf3fd5ddbfe173b5fe30036b2a440282ee85b90d010ff9aa4ccb42ab14e1b33c2f7f39d21153ef75adb16fa076cdaa221e9577b4b71080373bcad64b662bed5

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.4.8

data/README.md

@@ -1,59 +1,95 @@
 # NRQL2Nerd
+
 [![Ruby](https://github.com/aladac/nrql2nerd/actions/workflows/main.yml/badge.svg)](https://github.com/aladac/nrql2nerd/actions/workflows/main.yml)
 [![Gem Version](https://badge.fury.io/rb/nrql2nerd.svg)](https://badge.fury.io/rb/nrql2nerd)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+
+A lightweight Ruby gem for executing NRQL queries against New Relic's NerdGraph API. Skip the boilerplate and get straight to your data.
 
-This gem is a very simple lib which allows to directly execute `NRQL` queries on New Relic using the Nerd Graph API.
+## Features
+
+- Simple, intuitive API for NRQL queries
+- Works as a library or command-line tool
+- Environment variable or explicit credential configuration
+- Returns parsed JSON results ready for use
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
+Add to your Gemfile:
 
-    $ bundle add nrql2nerd
+```ruby
+gem "nrql2nerd"
+```
+
+Or install directly:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```bash
+gem install nrql2nerd
+```
 
-    $ gem install nrql2nerd
+## Configuration
+
+Set your New Relic credentials via environment variables:
+
+```bash
+export NEW_RELIC_API_KEY="your-api-key"
+export NEW_RELIC_ACCOUNT_ID="your-account-id"
+```
+
+Or pass them explicitly when creating a client.
 
 ## Usage
-### As a lib
+
+### As a Library
 
 ```ruby
-NRQL2Nerd.run_query("SELECT * from AjaxRequest where requestUrl like '%api%' LIMIT MAX")
+require "nrql2nerd"
+
+client = NRQL2Nerd::Client.new
+results = client.run_query("SELECT count(*) FROM Transaction SINCE 1 hour ago")
 
-# => [
-#  {
-#    "appId"=>12345,
-#    "message"=>"Some Message"
-#    ...
-#  }
-#]
+# => [{"count" => 42}]
 ```
-### As a command line tool
+
+With explicit credentials:
+
+```ruby
+client = NRQL2Nerd::Client.new(
+  api_key: "your-api-key",
+  account_id: "12345"
+)
 ```
-$ nrql2nerd "SELECT * from AjaxRequest where requestUrl like '%api%' LIMIT MAX"
-[
-  {
-    "appId"=>12345,
-    "message"=>"Some Message"
-    ...
-  }
-]
+
+### Command Line
+
+```bash
+# Using environment variables
+nrql2nerd -q "SELECT count(*) FROM Transaction SINCE 1 hour ago"
+
+# With explicit credentials
+nrql2nerd -q "SELECT * FROM Transaction LIMIT 10" \
+  --api-key your-api-key \
+  --account-id 12345
 ```
 
-## Development
+A shorter alias `n2n` is also available:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```bash
+n2n -q "SELECT count(*) FROM PageView SINCE 1 day ago"
+```
+
+## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```bash
+bin/setup          # Install dependencies
+bundle exec rake   # Run tests and linting
+bin/console        # Interactive prompt
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/aladac/nrql2nerd. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/nrql2nerd/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on [GitHub](https://github.com/aladac/nrql2nerd). Please follow the [code of conduct](https://github.com/aladac/nrql2nerd/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the NRQL2Nerd project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/nrql2nerd/blob/main/CODE_OF_CONDUCT.md).
+Available as open source under the [MIT License](https://opensource.org/licenses/MIT).

data/exe/n2n

@@ -0,0 +1 @@
+nrql2nerd

data/lib/nrql2nerd/client.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 module NRQL2Nerd
-  class Error < StandardError; end
-
   class Client
     def initialize(api_key: nil, account_id: nil)
       @api_key = ENV.fetch("NEW_RELIC_API_KEY", api_key)

data/lib/nrql2nerd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NRQL2Nerd
-  VERSION = "0.1.0"
+  VERSION = "0.1.3"
 end

data/sig/nrql2nerd.rbs

@@ -1,4 +1,20 @@
 module NRQL2Nerd
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  class Error < StandardError
+  end
+
+  class Client
+    @api_key: String
+    @account_id: String
+
+    def initialize: (?api_key: String?, ?account_id: String?) -> void
+    def graphql_nrql_query: (String query) -> String
+    def graphql_hash: (String query) -> Hash[Symbol, String]
+    def prepare_query: (String query) -> String
+    def client: () -> Net::HTTP
+    def uri: () -> URI::HTTPS
+    def make_query_request: (String query) -> Net::HTTPResponse
+    def run_query: (String query) -> Array[Hash[String, untyped]]?
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nrql2nerd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Adam Ladachowski
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-27 00:00:00.000000000 Z
+date: 2026-02-03 00:00:00.000000000 Z
 dependencies: []
 description: A tool to Send NRQL queries to New Relic API and get results in NerdGraph
   format
@@ -20,7 +20,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - ".rubocop.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
@@ -40,7 +42,7 @@ metadata:
   source_code_uri: https://github.com/aladac/nrql2nerd/blob/main
   changelog_uri: https://github.com/aladac/nrql2nerd/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -55,8 +57,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Send NRQL queries to New Relic API and get results in NerdGraph format
 test_files: []

data/exe/n2n

@@ -1,40 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "nrql2nerd"
-require "optparse"
-require "json"
-
-options = {}
-api_key = nil
-account_id = nil
-
-OptionParser.new do |opts|
-  opts.banner = "Usage: nrql2nerd [options]"
-
-  opts.on("-q", "--query QUERY", "NRQL query string") do |q|
-    options[:query] = q
-  end
-
-  opts.on("--api-key KEY", "New Relic API key") do |key|
-    api_key = key
-  end
-
-  opts.on("--account-id ID", "New Relic account ID") do |id|
-    account_id = id
-  end
-
-  opts.on("-h", "--help", "Prints this help") do
-    puts opts
-    exit
-  end
-end.parse!
-
-if options[:query]
-  client = NRQL2Nerd::Client.new(api_key: api_key, account_id: account_id)
-  result = client.run_query(options[:query])
-  puts JSON.pretty_generate(result)
-else
-  puts "Error: Query is required. Use -q or --query to specify the NRQL query."
-  exit 1
-end