synthetics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: faa9cfb4467b473fc3ff6f449700323299f6aabc
+  data.tar.gz: 0b299dd85fb09d6ba0f333713a1f05224bdae1ea
+SHA512:
+  metadata.gz: 82a1c2b7c62cb41a33568e219e20b4b065ef240b98675b07476b30bdee11fb2a26f9f4f9833c9862bdceb083b3355c35eeff8a8432bae69a9a7d9c1e024cf1f5
+  data.tar.gz: 40b6128f9374855cdc657d8b6b9fbda6cd41cf315873242415bf38a9b485721512037e54d334c139dba5b8984da3e14f3da65e81dc739ff546aa82d086984e79

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v0.1.0
+
+* Initial gem release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Swipely, Inc
+
+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,226 @@
+# Synthetics
+
+Synthetics is a rubygem that interfaces with New Relic Synthetics' [HTTP API](https://docs.newrelic.com/docs/apis/synthetics-rest-api/monitor-examples/manage-synthetics-monitors-via-rest-api).
+It can be used to manage monitors and labels programatically.
+The above link is useful for finding the possible options that can be passed to each method, particularly creating and updating monitors.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'synthetics'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install synthetics
+```
+
+## Usage
+
+All interaction with the API starts by creating an API client.
+The client requires an admin API key, which can be generated in the Web UI.
+Once you have your API key, there are two ways you can pass it to the client:
+
+```ruby
+> # Set API key directly:
+> synthetics = Synthetics.new('<YOUR-API-KEY>')
+
+> # Set API key via environment variable:
+> ENV['SYNTHETICS_API_KEY'] = 'YOUR-API-KEY'
+> synthetics = Synthetics.new
+```
+
+### Locations
+
+List locations:
+
+```ruby
+> synthetics.locations.list
+[
+  {:private=>false, :name=>"AWS_US_EAST_1", :label=>"Washington, DC, USA"},
+  ...
+]
+```
+
+### Monitors
+
+List monitors:
+
+```ruby
+> synthetics.monitors.list
+{
+  :monitors => [
+    {
+      :id => "SOME-VALID-UUID",
+      :name => "Ping Google",
+      :type => "SIMPLE",
+      :frequency => 1440,
+      :uri => "https://google.com",
+      :locations => ["AWS_US_EAST_1", "AWS_EU_WEST_1"],
+      :status => "ENABLED",
+      :sla_threshold => 7.0,
+      :modified_at => "2016-02-26T15:10:58.515+0000",
+      :created_at => "2016-02-26T15:10:58.515+0000",
+      :user_id => 123,
+      :api_version => "0.2.2"
+    }
+  ],
+  :count => 1
+}
+```
+
+Create monitor:
+
+```ruby
+> synthetics.monitors.create(
+> ...   name: 'Google Monitor',
+> ...   frequency: 15,
+> ...   uri: 'https://google.com',
+> ...   locations: %w(AWS_US_WEST_1),
+> ...   type: 'simple'
+> ... )
+nil
+```
+
+### Monitor
+
+These examples assume you have a valid monitor UUID, such as:
+
+```ruby
+> uuid = 'SOME-VAILD-UUID'
+```
+
+Show monitor:
+
+```ruby
+> synthetics.monitor(uuid).show
+{
+  :id => "SOME-VALID-UUID",
+  :name => "Ping Google",
+  :type => "SIMPLE",
+  :frequency => 15,
+  :uri => "https://google.com",
+  :locations => ["AWS_US_EAST_1", "AWS_EU_WEST_1"],
+  :status => "ENABLED",
+  :sla_threshold => 7.0,
+  :modified_at => "2016-02-26T15:10:58.515+0000",
+  :created_at => "2016-02-26T15:10:58.515+0000",
+  :user_id => 123,
+  :api_version => "0.2.2"
+}
+```
+
+Update monitor:
+
+```ruby
+> synthetics.monitor(uuid).update(
+> ...   name: 'Google Monitor',
+> ...   frequency: 30,
+> ...   uri: 'https://google.com',
+> ...   locations: %w(AWS_US_WEST_1),
+> ...   type: 'simple'
+> ... )
+
+{
+  :id => "SOME-VALID-UUID",
+  :name => "Ping Google",
+  :type => "SIMPLE",
+  :frequency => 30,
+  :uri => "https://google.com",
+  :locations => ["AWS_US_EAST_1", "AWS_EU_WEST_1"],
+  :status => "ENABLED",
+  :sla_threshold => 7.0,
+  :modified_at => "2016-02-26T15:10:58.515+0000",
+  :created_at => "2016-02-26T15:10:58.515+0000",
+  :user_id => 123,
+  :api_version => "0.2.2"
+}
+```
+
+Update monitor script:
+
+```ruby
+> synthetics.monitor(uuid).update_script('var test = function() {};')
+nil
+```
+
+Destroy monitor:
+
+```ruby
+> synthetics.monitor(uuid).destroy
+nil
+```
+
+### Labels
+
+
+List labels:
+
+```ruby
+> synthetics.labels.list
+{
+  :labels => [
+    {
+      :type => 'sha',
+      :value => '8ace32a'
+    }
+  ],
+  :count => 1
+}
+```
+
+### Label
+
+These examples assume you have a valid label, such as:
+
+```ruby
+> label = 'sample:label'
+```
+
+Show monitors for a label:
+
+```ruby
+> synthetics.label(label).monitors
+{
+  :monitors => [
+    {
+      :id => "SOME-VALID-UUID",
+      :name => "Ping Google",
+      :type => "SIMPLE",
+      :frequency => 1440,
+      :uri => "https://google.com",
+      :locations => ["AWS_US_EAST_1", "AWS_EU_WEST_1"],
+      :status => "ENABLED",
+      :sla_threshold => 7.0,
+      :modified_at => "2016-02-26T15:10:58.515+0000",
+      :created_at => "2016-02-26T15:10:58.515+0000",
+      :user_id => 123,
+      :api_version => "0.2.2"
+    }
+  ],
+  :count => 1
+}
+```
+
+Attach a label to a monitor:
+
+```ruby
+> synthetics.label(label).attach(uuid)
+nil
+```
+
+Remove a label from a monitor:
+
+```ruby
+> synthetics.label(label).remove(uuid)
+nil
+```

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'pry'
+
+desc 'Run the gem specs'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Load the gem'
+task :environment do
+  $LOAD_PATH << File.expand_path('../lib', __FILE__)
+  require 'synthetics'
+end
+
+desc 'Start a console in the context of the Synthetics module'
+task shell: :environment do
+  Pry.start(Synthetics)
+end
+
+task default: :spec

data/lib/synthetics.rb

@@ -0,0 +1,21 @@
+require 'base64'
+require 'excon'
+require 'json'
+
+require 'synthetics/version'
+require 'synthetics/constants'
+require 'synthetics/errors'
+require 'synthetics/util'
+require 'synthetics/client'
+require 'synthetics/api'
+
+# Top level gem namespace.
+module Synthetics
+  def self.new(api_key = ENV[API_KEY_ENVIRONMENT_VARIABLE])
+    if api_key.nil?
+      fail NoAPIKeyError,
+           "No API key given, please set $#{API_KEY_ENVIRONMENT_VARIABLE}"
+    end
+    API.new(Client.new(api_key))
+  end
+end

data/lib/synthetics/api.rb

@@ -0,0 +1,37 @@
+require 'synthetics/api/base'
+require 'synthetics/api/label'
+require 'synthetics/api/labels'
+require 'synthetics/api/locations'
+require 'synthetics/api/monitor'
+require 'synthetics/api/monitors'
+
+module Synthetics
+  # This class holds the sub APIs used to communicate with synthetics.
+  class API
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def label(label)
+      Label.new(client, label)
+    end
+
+    def labels
+      Labels.new(client)
+    end
+
+    def locations
+      Locations.new(client)
+    end
+
+    def monitor(monitor_uuid)
+      Monitor.new(client, monitor_uuid)
+    end
+
+    def monitors
+      Monitors.new(client)
+    end
+  end
+end

data/lib/synthetics/api/base.rb

@@ -0,0 +1,15 @@
+module Synthetics
+  class API
+    # This class defines common methods for all APIs.
+    class Base
+      extend Forwardable
+
+      attr_reader :client
+      def_delegators :@client, :request
+
+      def initialize(client)
+        @client = client
+      end
+    end
+  end
+end

data/lib/synthetics/api/label.rb

@@ -0,0 +1,32 @@
+module Synthetics
+  class API
+    # This class makes requests to the labels section of the Synthetics API.
+    class Label < Base
+      attr_reader :label
+
+      def initialize(client, label)
+        super(client)
+        @label = label
+      end
+
+      def monitors
+        request(method: 'GET', path: "/monitors/labels/#{label}")
+      end
+
+      def attach(monitor_uuid)
+        request(
+          method: 'POST',
+          path: "/monitors/#{monitor_uuid}/labels",
+          body: label
+        )
+      end
+
+      def remove(monitor_uuid)
+        request(
+          method: 'DELETE',
+          path: "/monitors/#{monitor_uuid}/labels/#{label}"
+        )
+      end
+    end
+  end
+end

data/lib/synthetics/api/labels.rb

@@ -0,0 +1,11 @@
+module Synthetics
+  class API
+    # This class makes requests to the collection methods of the labels section
+    # of the Synthetics API.
+    class Labels < Base
+      def list
+        request(method: 'GET', path: '/monitors/labels')
+      end
+    end
+  end
+end

data/lib/synthetics/api/locations.rb

@@ -0,0 +1,10 @@
+module Synthetics
+  class API
+    # This class makes requests to the locations section of the Synthetics API.
+    class Locations < Base
+      def list
+        request(method: 'GET', path: '/locations')
+      end
+    end
+  end
+end

data/lib/synthetics/api/monitor.rb

@@ -0,0 +1,33 @@
+module Synthetics
+  class API
+    # This class makes requests to the monitors section of the Synthetics API.
+    class Monitor < Base
+      attr_reader :monitor_uuid
+
+      def initialize(client, monitor_uuid)
+        super(client)
+        @monitor_uuid = monitor_uuid
+      end
+
+      def show
+        request(path: "/monitors/#{monitor_uuid}", method: 'GET')
+      end
+
+      def update(options)
+        request(path: "/monitors/#{monitor_uuid}", method: 'PUT', body: options)
+      end
+
+      def update_script(str)
+        request(
+          path: "/monitors/#{monitor_uuid}/script",
+          method: 'PUT',
+          body: { script_text: Base64.strict_encode64(str) }
+        )
+      end
+
+      def destroy
+        request(path: "/monitors/#{monitor_uuid}", method: 'DELETE')
+      end
+    end
+  end
+end

data/lib/synthetics/api/monitors.rb

@@ -0,0 +1,15 @@
+module Synthetics
+  class API
+    # This class makes requests to the collection methods in the monitors
+    # section of the Synthetics API.
+    class Monitors < Base
+      def list
+        request(path: '/monitors', method: 'GET')
+      end
+
+      def create(options)
+        request(path: '/monitors', method: 'POST', body: options)
+      end
+    end
+  end
+end

data/lib/synthetics/client.rb

@@ -0,0 +1,48 @@
+module Synthetics
+  # This class wraps Excon to make requests to the Synthetics API.
+  class Client
+    include Util
+
+    def initialize(api_key)
+      @api_key = api_key.freeze
+    end
+
+    def request(options)
+      wrap_errors do
+        normailze_request_options!(options)
+        response = excon.request(options)
+        return nil if response.body.empty?
+        deep_snakeify_keys(JSON.parse(response.body))
+      end
+    end
+
+    private
+
+    def wrap_errors
+      yield
+    rescue JSON::JSONError => ex
+      raise ParseError, ex
+    rescue Excon::Errors::ClientError => ex
+      raise ClientError, ex
+    rescue Excon::Errors::ServerError => ex
+      raise ServerError, ex
+    end
+
+    def normailze_request_options!(opts)
+      opts[:path] = API_PATH_PREFIX + opts[:path]
+      opts[:headers] ||= {}
+      opts[:headers].merge!(
+        'Content-Type' => 'application/json',
+        'X-API-Key' => @api_key
+      )
+      if opts.key?(:body) && !opts[:body].is_a?(String)
+        opts[:body] = deep_camelize_keys(opts[:body]).to_json
+      end
+      opts[:expects] = 200..204
+    end
+
+    def excon
+      @excon ||= Excon.new(API_HOST)
+    end
+  end
+end

data/lib/synthetics/constants.rb

@@ -0,0 +1,6 @@
+# Application level constants.
+module Synthetics
+  API_PATH_PREFIX = '/synthetics/api/v1'.freeze
+  API_HOST = 'https://synthetics.newrelic.com'.freeze
+  API_KEY_ENVIRONMENT_VARIABLE = 'SYNTHETICS_API_KEY'.freeze
+end

data/lib/synthetics/errors.rb

@@ -0,0 +1,12 @@
+module Synthetics
+  # Catch-all error class.
+  Error = Class.new(StandardError)
+  # Raised when parsing JSON fails.
+  ParseError = Class.new(Error)
+  # Raised when there is a 400 level error returned from the Synthetics API.
+  ClientError = Class.new(Error)
+  # Raised when there is a 500 level error returned from the Synthetics API.
+  ServerError = Class.new(Error)
+  # Raised when no API is given to a Synthetics client.
+  NoAPIKeyError = Class.new(Error)
+end

data/lib/synthetics/util.rb

@@ -0,0 +1,36 @@
+module Synthetics
+  # This module holds general purpose utilities for the gem.
+  module Util
+    module_function
+
+    def deep_snakeify_keys(object)
+      deep_transform_keys(object) { |key| snakeify(key).to_sym }
+    end
+
+    def deep_camelize_keys(object)
+      deep_transform_keys(object) { |key| camelize(key.to_s) }
+    end
+
+    def deep_transform_keys(object, &block)
+      case object
+      when Hash
+        object.each_with_object({}) do |(key, value), hash|
+          hash[yield key] = deep_transform_keys(value, &block)
+        end
+      when Array
+        object.map { |elem| deep_transform_keys(elem, &block) }
+      else
+        object
+      end
+    end
+
+    def camelize(str)
+      first, *rest = str.split('_')
+      rest.each_with_object(first) { |word, memo| memo << word.capitalize }
+    end
+
+    def snakeify(str)
+      str.gsub(/[A-Z]/) { |letter| "_#{letter.downcase}" }
+    end
+  end
+end

data/lib/synthetics/version.rb

@@ -0,0 +1,4 @@
+# This file contains version information for the gem.
+module Synthetics
+  VERSION = '0.1.0'.freeze
+end

data/synthetics.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'synthetics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'synthetics'
+  spec.version       = Synthetics::VERSION
+  spec.authors       = ['Tom Hulihan']
+  spec.email         = ['hulihan.tom159@gmail.com']
+
+  spec.summary       = 'Ruby client for the New Relic Synthetics'
+  spec.description   = <<-EOS
+synthetics interfaces with New Relic Synthetics' HTTP API:
+https://docs.newrelic.com/docs/apis/synthetics-rest-api/. The gem can be used to
+read, create, update, and destroy monitors.
+EOS
+  spec.homepage      = 'https://github.com/swipely/synthetics'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.start_with?('spec')
+  end
+  spec.require_paths = %w(lib)
+
+  spec.add_dependency 'excon'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 1.22'
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: synthetics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Hulihan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  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: 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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !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: vcr
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+description: |
+  synthetics interfaces with New Relic Synthetics' HTTP API:
+  https://docs.newrelic.com/docs/apis/synthetics-rest-api/. The gem can be used to
+  read, create, update, and destroy monitors.
+email:
+- hulihan.tom159@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/synthetics.rb
+- lib/synthetics/api.rb
+- lib/synthetics/api/base.rb
+- lib/synthetics/api/label.rb
+- lib/synthetics/api/labels.rb
+- lib/synthetics/api/locations.rb
+- lib/synthetics/api/monitor.rb
+- lib/synthetics/api/monitors.rb
+- lib/synthetics/client.rb
+- lib/synthetics/constants.rb
+- lib/synthetics/errors.rb
+- lib/synthetics/util.rb
+- lib/synthetics/version.rb
+- synthetics.gemspec
+homepage: https://github.com/swipely/synthetics
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Ruby client for the New Relic Synthetics
+test_files: []