new_relic-rest_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e08f4dc0227235037b84cb045d0f8a6a479349d
+  data.tar.gz: 2e419422ad1a71660bc19024809ed4d225ba8f12
+SHA512:
+  metadata.gz: 6860c090abc3cafd930e7e16b6e1910442a05fc727e77a695de9b7e4a3fcf8a7c6e5f414bc08907be25787fc465178346abcfb0454293feab3f6f6ead71482da
+  data.tar.gz: 68e6a98210d2d55a8f43abdb47a199c52302e51bc608bafa75524459d7dab6a13b8ad60752db3fde2a634f78ebdf660ad9a303c17cebdb03af300cae59efa9ef

data/.env.sample

@@ -0,0 +1 @@
+NEW_RELIC_REST_API_KEY=''

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+.ruby-version
+.ruby-gemset

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at tomas_stefano@successoft.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in new_relic-rest_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Tomas D'Stefano
+
+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,54 @@
+# NewRelic::RestApi
+
+New Relic client for the v2 Rest API:
+
+https://docs.newrelic.com/docs/apis/rest-api-v2.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'new_relic-rest_api', require: 'new_relic/rest_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install new_relic-rest_api
+
+## Usage
+
+You need to setup your new relic api key:
+
+```ruby
+require 'new_relic/rest_api'
+
+NewRelic::RestApi.config do |config|
+  config.key = '<your-api-key>'
+end
+```
+There other options you can setup like:
+
+timeout, open_timeout, retries, ssl_options.
+
+Then you can play with the application resource:
+
+```ruby
+  applications = NewRelic::RestApi::Application.all
+```
+
+In order to get the metric names for each application:
+
+```ruby
+  applications.map(&:metric_names)
+```
+
+In order to get the metrics data for each application:
+
+```ruby
+  applications.map { |app| app.metric_data(names: ['<some-metric-name-from-above>']) }
+```

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'dotenv'
+Dotenv.load
+require 'new_relic/rest_api'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc 'Runs an IRB session'
+task :console do
+  NewRelic::RestApi.config do |config|
+    config.key = ENV['NEW_RELIC_REST_API_KEY']
+    config.ssl_options = { verify: false }
+  end
+
+  ARGV.clear
+  require 'irb'
+  IRB.start
+end

data/TODO.md

@@ -0,0 +1,12 @@
+## Todo list
+
+Above you can see the following tasks for future versions:
+
+### Resources
+
+* Applications resource (https://rpm.newrelic.com/api/explore/applications)
+
+### Miscellaneous
+
+* Pagination for API output
+* Cache client requests

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "new_relic/rest_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/new_relic/rest_api.rb

@@ -0,0 +1,23 @@
+require 'virtus'
+require 'new_relic/rest_api/version'
+require 'new_relic/rest_api/config'
+require 'new_relic/rest_api/connection'
+require 'new_relic/rest_api/resource'
+require 'new_relic/rest_api/response_collection'
+require 'new_relic/rest_api/application'
+
+module NewRelic
+  module RestApi
+    def self.config
+      @config ||= NewRelic::RestApi::Config.new
+
+      yield(@config) if block_given?
+
+      @config
+    end
+
+    def self.connection
+      @connection ||= NewRelic::RestApi::Connection.new
+    end
+  end
+end

data/lib/new_relic/rest_api/application.rb

@@ -0,0 +1,29 @@
+require 'new_relic/rest_api/application_metric_names'
+require 'new_relic/rest_api/application_metric_data'
+
+module NewRelic
+  module RestApi
+    class Application < NewRelic::RestApi::Resource
+      attribute :id, Integer
+      attribute :name, String
+      attribute :language, String
+      attribute :health_status, String
+      attribute :reporting, Boolean
+      attribute :last_reported_at, DateTime
+      attribute :application_summary, Hash
+      attribute :settings, Hash
+      attribute :links, Array
+
+      def metric_names
+        ApplicationMetricNames.all(application_id: id)
+      end
+
+      def metric_data(names: [])
+        ApplicationMetricData.all(
+          application_id: id,
+          params: { names: names }
+        )
+      end
+    end
+  end
+end

data/lib/new_relic/rest_api/application_metric_data.rb

@@ -0,0 +1,16 @@
+module NewRelic
+  module RestApi
+    class ApplicationMetricData < NewRelic::RestApi::Resource
+      attribute :name, Array
+      attribute :timeslices, Array
+
+      def self.requested_path(options = {})
+        "applications/#{options.fetch(:application_id)}/metrics/data"
+      end
+
+      def self.resource_name
+        ['metric_data', 'metrics']
+      end
+    end
+  end
+end

data/lib/new_relic/rest_api/application_metric_names.rb

@@ -0,0 +1,16 @@
+module NewRelic
+  module RestApi
+    class ApplicationMetricNames < NewRelic::RestApi::Resource
+      attribute :name
+      attribute :values, Array
+
+      def self.requested_path(options = {})
+        "applications/#{options.fetch(:application_id)}/#{resource_name}"
+      end
+
+      def self.resource_name
+        'metrics'
+      end
+    end
+  end
+end

data/lib/new_relic/rest_api/config.rb

@@ -0,0 +1,42 @@
+module NewRelic
+  module RestApi
+    class Config
+      attr_accessor :host,
+                    :api_version,
+                    :key,
+                    :retries,
+                    :timeout,
+                    :open_timeout
+
+      ## Pass the SSL certificates location
+      # For more information read:
+      # https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates
+      #
+      attr_accessor :ssl_options
+
+      def host
+        @host ||= 'https://api.newrelic.com'
+      end
+
+      def api_version
+        @api_version ||= 'v2'
+      end
+
+      def timeout
+        @timeout ||= 10
+      end
+
+      def open_timeout
+        @open_timeout ||= 10
+      end
+
+      def retries
+        @retries ||= 0
+      end
+
+      def ssl_options
+        @ssl_options ||= {}
+      end
+    end
+  end
+end

data/lib/new_relic/rest_api/connection.rb

@@ -0,0 +1,48 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday/conductivity'
+require 'delegate'
+
+module NewRelic
+  module RestApi
+    class Connection < SimpleDelegator
+      def initialize
+        require 'logger'
+        @raw_connection = Faraday.new(http_options) do |faraday|
+          faraday.request :json
+          faraday.request :retry, max: config.retries
+          faraday.request :user_agent,
+                          app: 'NewRelic::RestApi gem',
+                          version: NewRelic::RestApi::VERSION
+          #faraday.response :logger, ::Logger.new(STDOUT), bodies: true
+          faraday.response :json
+          faraday.response :raise_error
+          faraday.adapter Faraday.default_adapter
+        end
+
+        super(@raw_connection)
+      end
+
+      private
+
+      def http_options
+        options = {
+          url: config.host,
+          request: {
+            timeout: config.timeout,
+            open_timeout: config.open_timeout
+          },
+          headers: {
+            'X-Api-Key' => config.key
+          }
+        }
+        options[:ssl] = config.ssl_options unless config.ssl_options.empty?
+        options
+      end
+
+      def config
+        NewRelic::RestApi.config
+      end
+    end
+  end
+end

data/lib/new_relic/rest_api/resource.rb

@@ -0,0 +1,44 @@
+require 'active_support/inflector'
+
+module NewRelic
+  module RestApi
+    class Resource
+      include Virtus.model
+
+      def self.all(options = {})
+        response = connection.get(path(options), options.delete(:params))
+        body = response.body.dig(*resource_name)
+
+        ResponseCollection.new(response, body: body) do |record|
+          new(record)
+        end
+      end
+
+      def self.find(id)
+        response = connection.get(path(id: id))
+        body = response.body[resource_name.singularize]
+
+        new(body)
+      end
+
+      def self.path(options = {})
+        [
+          NewRelic::RestApi.config.api_version,
+          requested_path(options)
+        ].compact.join('/').concat('.json')
+      end
+
+      def self.requested_path(options = {})
+        [resource_name, options[:id]].compact.join('/')
+      end
+
+      def self.resource_name
+        name.demodulize.underscore.dasherize.pluralize
+      end
+
+      def self.connection
+        NewRelic::RestApi.connection
+      end
+    end
+  end
+end

data/lib/new_relic/rest_api/response_collection.rb

@@ -0,0 +1,19 @@
+module NewRelic
+  module RestApi
+    class ResponseCollection < Array
+      attr_reader :response, :body, :collection
+
+      def initialize(response, options, &block)
+        @response = response
+        @body = options.fetch(:body)
+        @collection = @body.map(&block)
+
+        super(@collection)
+      end
+
+      def inspect
+        "#<ResponseCollection:#{object_id} #{collection}>"
+      end
+    end
+  end
+end

data/lib/new_relic/rest_api/version.rb

@@ -0,0 +1,5 @@
+module NewRelic
+  module RestApi
+    VERSION = "0.1.0"
+  end
+end

data/new_relic-rest_api.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'new_relic/rest_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "new_relic-rest_api"
+  spec.version       = NewRelic::RestApi::VERSION
+  spec.authors       = ["Tomas D'Stefano"]
+  spec.email         = ["tomas_stefano@successoft.com"]
+
+  spec.summary       = %q{
+    New Relic client v2 Rest API.
+  }
+  spec.description   = %q{
+    New Relic client v2 Rest API: https://docs.newrelic.com/docs/apis/rest-api-v2.
+  }
+  spec.homepage      = 'https://github.com/tomas-stefano/new_relic-api_client'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday', '~> 0.12'
+  spec.add_dependency 'faraday_middleware', '~> 0.11'
+  spec.add_dependency 'faraday-conductivity', '~> 0.3'
+  spec.add_dependency 'activesupport', '>= 4'
+  spec.add_dependency 'virtus', '~> 1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'dotenv'
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: new_relic-rest_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas D'Stefano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: faraday-conductivity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n    New Relic client v2 Rest API: https://docs.newrelic.com/docs/apis/rest-api-v2.\n
+  \ "
+email:
+- tomas_stefano@successoft.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- bin/console
+- bin/setup
+- lib/new_relic/rest_api.rb
+- lib/new_relic/rest_api/application.rb
+- lib/new_relic/rest_api/application_metric_data.rb
+- lib/new_relic/rest_api/application_metric_names.rb
+- lib/new_relic/rest_api/config.rb
+- lib/new_relic/rest_api/connection.rb
+- lib/new_relic/rest_api/resource.rb
+- lib/new_relic/rest_api/response_collection.rb
+- lib/new_relic/rest_api/version.rb
+- new_relic-rest_api.gemspec
+homepage: https://github.com/tomas-stefano/new_relic-api_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: New Relic client v2 Rest API.
+test_files: []