rollbar-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b174a393dd39338a440f851db212dd871e8ad4a5
+  data.tar.gz: 958b809533fa494ff7729ae0fb1fa882e8cc439a
+SHA512:
+  metadata.gz: ef6be010762ed92e51e895aa5d849032d883acbcf18fb0296dcc1d05d3b9665d9cafd7fdc5be37340deb20ebc94012395fb0604f523640270ac8d1c604c2a70b
+  data.tar.gz: 335a1d5139c03af4e730bb875b239a991db54a1044bcf6e65cc8925f11b5f3f6c126450a244a31e0785dae5dfc537e66e123d70a71ce7076bc28846f208e5b89

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status
+
+.env

data/.rspec

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,71 @@
+# rollbar-api [![CircleCI](https://circleci.com/gh/wealthsimple/rollbar-api.svg?style=svg)](https://circleci.com/gh/wealthsimple/rollbar-api)
+
+Rubygem for accessing Rollbar's full REST and RQL APIs.
+
+## Installation
+
+Add this line to your application's Gemfile and run `bundle` to install:
+
+```ruby
+gem 'rollbar-api'
+```
+
+## Usage
+
+First, generate read-only access tokens for each project you need access to by navigating to **Settings** > **Project Access Tokens** and clicking **Add new access token**.
+
+Next, configure each project:
+
+```ruby
+# config/initializers/rollbar-api.rb in a Rails project
+require 'rollbar-api'
+
+# Add as many projects as you need. Each should have a unique access token.
+RollbarApi::Project.add("my-project", ENV["MY_PROJECT_ACCESS_TOKEN"])
+RollbarApi::Project.add("other-project", ENV["OTHER_PROJECT_ACCESS_TOKEN"])
+```
+
+### REST API
+
+You can make HTTP `GET` calls to fetch items, deploys, occurrences, and so on by finding any project you added in the configuration and calling `.get` with the API endpoint:
+
+```ruby
+items = RollbarApi::Project.find("my-project").get("/api/1/items/")
+```
+
+Specify query parameters by passing them in as a hash:
+
+```ruby
+top_items = RollbarApi::Project.find("my-project").get("/api/1/reports/top_active_items", {
+  hours: "24",
+  environments: "production,staging",
+})
+```
+
+### RQL Queries
+
+You can also run RQL queries:
+
+```ruby
+# Create a job
+rql_job = RollbarApi::Project.find("my-project").post("/api/1/rql/jobs", {
+  query_string: "select * from item_occurrence where item.counter=1",
+})
+
+# Check its status
+rql_job = RollbarApi::Project.find("my-project").get("/api/1/rql/job/#{rql_job.result.id}")
+
+# If it succeeded, get the RQL result
+if rql_job.result.status == "success"
+  rql_result = RollbarApi::Project.find("my-project").get("/api/1/rql/job/#{rql_job.result.id}/result")
+  p rql_result
+end
+```
+
+See https://rollbar.com/docs/api/ for a full reference of API requests and responses.
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rollbar-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(__FILE__)

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/examples/list_items.rb

@@ -0,0 +1,18 @@
+require "dotenv/load"
+require "pp"
+require "bundler/setup"
+require "rollbar-api"
+
+project_name = ENV["ROLLBAR_PROJECT_NAME"] or raise "Must specify ROLLBAR_PROJECT_NAME in .env"
+project_access_token = ENV["ROLLBAR_PROJECT_ACCESS_TOKEN"] or raise "Must specify ROLLBAR_PROJECT_ACCESS_TOKEN in .env"
+
+RollbarApi::Project.add(project_name, project_access_token)
+
+# Fetch all items
+items = RollbarApi::Project.find(project_name).get("/api/1/items")
+
+# Print out the first 5 items
+items.result.items.first(5).each do |item|
+  pp item
+  puts "=" * 80
+end

data/examples/rql_query.rb

@@ -0,0 +1,23 @@
+require "dotenv/load"
+require "pp"
+require "bundler/setup"
+require "rollbar-api"
+
+project_name = ENV["ROLLBAR_PROJECT_NAME"] or raise "Must specify ROLLBAR_PROJECT_NAME in .env"
+project_access_token = ENV["ROLLBAR_PROJECT_ACCESS_TOKEN"] or raise "Must specify ROLLBAR_PROJECT_ACCESS_TOKEN in .env"
+
+RollbarApi::Project.add(project_name, project_access_token)
+
+# Create the job
+rql_job = RollbarApi::Project.find(project_name).post("/api/1/rql/jobs", {
+  query_string: "select * from item_occurrence where item.counter=1",
+})
+
+# Fetch job status
+rql_job = RollbarApi::Project.find(project_name).get("/api/1/rql/job/#{rql_job.result.id}")
+pp rql_job
+
+if rql_job.result.status == "success"
+  # Print out succeeded job result
+  pp RollbarApi::Project.find(project_name).get("/api/1/rql/job/#{rql_job.result.id}/result")
+end

data/examples/top_active_items.rb

@@ -0,0 +1,19 @@
+require "dotenv/load"
+require "pp"
+require "bundler/setup"
+require "rollbar-api"
+
+project_name = ENV["ROLLBAR_PROJECT_NAME"] or raise "Must specify ROLLBAR_PROJECT_NAME in .env"
+project_access_token = ENV["ROLLBAR_PROJECT_ACCESS_TOKEN"] or raise "Must specify ROLLBAR_PROJECT_ACCESS_TOKEN in .env"
+
+RollbarApi::Project.add(project_name, project_access_token)
+
+top_active_items = RollbarApi::Project.find(project_name).get("/api/1/reports/top_active_items", {
+  hours: "24",
+  environments: "production,staging",
+})
+
+top_active_items.result.each_with_index do |item, i|
+  pp i, item
+  puts "=" * 80
+end

data/lib/rollbar-api.rb

@@ -0,0 +1,13 @@
+require "active_support"
+require "active_support/core_ext"
+require "faraday"
+require "json"
+require "recursive-open-struct"
+
+require "rollbar-api/project"
+require "rollbar-api/request"
+require "rollbar-api/resource"
+require "rollbar-api/version"
+
+module RollbarApi
+end

data/lib/rollbar-api/project.rb

@@ -0,0 +1,40 @@
+module RollbarApi
+  class Project
+    @@projects = {}
+
+    def self.add(project_name, project_access_token)
+      @@projects[project_name] = project_access_token
+    end
+
+    def self.find(project_name)
+      project_access_token = @@projects[project_name]
+      new(project_name, project_access_token) if project_access_token.present?
+    end
+
+    def self.all
+      @@projects.map { |project_name, _| find(project_name) }
+    end
+
+    def self.delete_all
+      @@projects = {}
+    end
+
+    attr_reader :name, :access_token
+    def initialize(name, access_token)
+      @name = name
+      @access_token = access_token
+    end
+
+    %i(get post put delete head patch).each do |http_method|
+      define_method(http_method) do |path, params = {}|
+        params[:access_token] = access_token
+        response = Request.new(method: http_method, path: path, params: params).execute
+        if response.is_a?(Array)
+          response.map { |r| Resource.new(r) }
+        else
+          Resource.new(response)
+        end
+      end
+    end
+  end
+end

data/lib/rollbar-api/request.rb

@@ -0,0 +1,46 @@
+module RollbarApi
+  class Request
+    attr_reader :method, :path, :params
+    def initialize(method:, path:, params:)
+      @method = method
+      path = "/#{path}" unless path.start_with?("/")
+      @path = path
+      @params = params
+    end
+
+    def execute
+      connection.send(method) do |request|
+        if method == :get
+          request.url("#{path}?#{params.to_param}")
+        else
+          request.url(path)
+          request.body = body_to_json(params) if params.present?
+        end
+        
+        request.headers.merge!({
+          "Accept" => "application/json",
+          "Content-Type" => "application/json",
+        })
+        request
+      end
+    end
+
+  private
+
+    def connection
+      Faraday.new(url: "https://api.rollbar.com") do |faraday|
+        faraday.response :logger, ::Logger.new(STDOUT), bodies: false
+        faraday.adapter Faraday.default_adapter
+        faraday.use Faraday::Response::RaiseError
+      end
+    end
+
+    def body_to_json(body)
+      if body
+        body.is_a?(Array) || body.is_a?(Hash) ? body.to_json : body
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/rollbar-api/resource.rb

@@ -0,0 +1,23 @@
+module RollbarApi
+  class Resource
+    attr_reader :response_json
+
+    def initialize(response)
+      response = response.body if response.is_a?(Faraday::Response)
+      @response_json = if response.is_a?(String)
+        JSON.parse(response)
+      else
+        response
+      end
+      @struct = RecursiveOpenStruct.new(@response_json, {recurse_over_arrays: true})
+    end
+
+    def as_json(options = {})
+      @response_json
+    end
+
+    def method_missing(name, *args)
+      @struct.send(name, *args)
+    end
+  end
+end

data/lib/rollbar-api/version.rb

@@ -0,0 +1,3 @@
+module RollbarApi
+  VERSION = "0.1.0"
+end

data/rollbar-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 "rollbar-api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rollbar-api"
+  spec.version       = RollbarApi::VERSION
+  spec.authors       = ["Peter Graham"]
+  spec.email         = ["peter@wealthsimple.com"]
+
+  spec.summary       = %q{Rubygem for Rollbar REST and RQL APIs}
+  spec.description   = %q{Rubygem for accessing Rollbar's full REST and RQL APIs.}
+  spec.homepage      = "https://github.com/wealthsimple/rollbar-api"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.license       = "MIT"
+
+  spec.add_dependency "activesupport", ">= 4"
+  spec.add_dependency "faraday", "0.12.1"
+  spec.add_dependency "recursive-open-struct"
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "rspec-collection_matchers"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.2"
+  spec.add_development_dependency "webmock", "~> 3.0"
+  spec.add_development_dependency "dotenv"
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: rollbar-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Graham
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-05 00:00:00.000000000 Z
+dependencies:
+- !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: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  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.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: rspec-its
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: Rubygem for accessing Rollbar's full REST and RQL APIs.
+email:
+- peter@wealthsimple.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/list_items.rb
+- examples/rql_query.rb
+- examples/top_active_items.rb
+- lib/rollbar-api.rb
+- lib/rollbar-api/project.rb
+- lib/rollbar-api/request.rb
+- lib/rollbar-api/resource.rb
+- lib/rollbar-api/version.rb
+- rollbar-api.gemspec
+homepage: https://github.com/wealthsimple/rollbar-api
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rubygem for Rollbar REST and RQL APIs
+test_files: []