nrql2nerd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ddaca5d74da000d97860a064875d2409877798267416701bc9fbb236ae14e2a5
+  data.tar.gz: 672ed206989168c77f0fe1064c4696568e49d1b9476108969b63f63d457bc8ec
+SHA512:
+  metadata.gz: c01f9e36d7dfdfb08b75dbe25a410ecaed1ed58d12aead8bb83b4e6366c42df21e79fb5c9548740b375a50892eef8435aeb96d7376858b0eefdc7b3d4d303893
+  data.tar.gz: d51dfe7b49a9f0de1f76b388ea3b4f11651982d173781665f7cf474ad0c622f51ad1e643118c53b93c51ad6decdb8b21c5fae4b46c5f1f633996301f32fdd519

data/.rubocop.yml

@@ -0,0 +1,16 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-09-25
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Adam Ladachowski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# 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)
+
+This gem is a very simple lib which allows to directly execute `NRQL` queries on New Relic using the Nerd Graph API.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add nrql2nerd
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install nrql2nerd
+
+## Usage
+### As a lib
+
+```ruby
+NRQL2Nerd.run_query("SELECT * from AjaxRequest where requestUrl like '%api%' LIMIT MAX")
+
+# => [
+#  {
+#    "appId"=>12345,
+#    "message"=>"Some Message"
+#    ...
+#  }
+#]
+```
+### As a command line tool
+```
+$ nrql2nerd "SELECT * from AjaxRequest where requestUrl like '%api%' LIMIT MAX"
+[
+  {
+    "appId"=>12345,
+    "message"=>"Some Message"
+    ...
+  }
+]
+```
+
+## Development
+
+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.
+
+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).
+
+## 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).
+
+## 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).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/exe/n2n

@@ -0,0 +1,40 @@
+#!/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

data/exe/nrql2nerd

@@ -0,0 +1,40 @@
+#!/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

data/lib/nrql2nerd/client.rb

@@ -0,0 +1,65 @@
+# 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)
+      @account_id = ENV.fetch("NEW_RELIC_ACCOUNT_ID", account_id)
+
+      raise "NEW_RELIC_API_KEY is not set" if @api_key.nil?
+      raise "NEW_RELIC_ACCOUNT_ID is not set" if @account_id.nil?
+    end
+
+    def graphql_nrql_query(query)
+      <<~GRAPHQL
+          query {
+            actor {
+              account(id: #{@account_id}) {
+              nrql(query: "#{query}") {
+                results
+              }
+            }
+          }
+        }
+      GRAPHQL
+    end
+
+    def graphql_hash(query)
+      {
+        query: graphql_nrql_query(query)
+      }
+    end
+
+    def prepare_query(query)
+      JSON.pretty_generate(graphql_hash(query))
+    end
+
+    def client
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+
+      http
+    end
+
+    def uri
+      URI("https://api.newrelic.com/graphql")
+    end
+
+    def make_query_request(query)
+      request = Net::HTTP::Post.new(uri)
+      request["Content-Type"] = "application/json"
+      request["API-Key"] = @api_key
+      request.body = prepare_query(query)
+
+      client.request(request)
+    end
+
+    def run_query(query)
+      response = make_query_request(query)
+
+      JSON.parse(response.body).dig("data", "actor", "account", "nrql", "results")
+    end
+  end
+end

data/lib/nrql2nerd/version.rb

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

data/lib/nrql2nerd.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "nrql2nerd/version"
+require_relative "nrql2nerd/client"
+require "json"
+require "net/http"
+require "uri"
+
+module NRQL2Nerd
+  class Error < StandardError; end
+end

data/sig/nrql2nerd.rbs

@@ -0,0 +1,4 @@
+module NRQL2Nerd
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: nrql2nerd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Ladachowski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-09-27 00:00:00.000000000 Z
+dependencies: []
+description: A tool to Send NRQL queries to New Relic API and get results in NerdGraph
+  format
+email:
+- adam.ladachowski@gmail.com
+executables:
+- n2n
+- nrql2nerd
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/n2n
+- exe/nrql2nerd
+- lib/nrql2nerd.rb
+- lib/nrql2nerd/client.rb
+- lib/nrql2nerd/version.rb
+- sig/nrql2nerd.rbs
+homepage: https://github.com/aladac/nrql2nerd/blob/main
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aladac/nrql2nerd/blob/main/blob/main/README.md
+  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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key: 
+specification_version: 4
+summary: Send NRQL queries to New Relic API and get results in NerdGraph format
+test_files: []