rollbar-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b174a393dd39338a440f851db212dd871e8ad4a5
-  data.tar.gz: 958b809533fa494ff7729ae0fb1fa882e8cc439a
+  metadata.gz: de7fea7977ca5a014746909d9e82d7da1130b91f
+  data.tar.gz: 1af351ceaa9d3eb1589ad1d0ce79baf5548110ba
 SHA512:
-  metadata.gz: ef6be010762ed92e51e895aa5d849032d883acbcf18fb0296dcc1d05d3b9665d9cafd7fdc5be37340deb20ebc94012395fb0604f523640270ac8d1c604c2a70b
-  data.tar.gz: 335a1d5139c03af4e730bb875b239a991db54a1044bcf6e65cc8925f11b5f3f6c126450a244a31e0785dae5dfc537e66e123d70a71ce7076bc28846f208e5b89
+  metadata.gz: 650c9cddc0c41e6bcbd28786a28c034742149f18178bfa5c44af22f05948fdc916d87dc0d0e99126cd052d53ac5b91ffac663bb92c7aa0ab782b454b99d058db
+  data.tar.gz: 2046181b08ebdbe7af9e562e31e381204433c99e6341c8c403e5aa0b6c1127c65f677f7df3a8293369ed8180eaba2cd0802d31b91b53347803af8f5bc1495dba

data/README.md

@@ -1,7 +1,11 @@
-# rollbar-api [![CircleCI](https://circleci.com/gh/wealthsimple/rollbar-api.svg?style=svg)](https://circleci.com/gh/wealthsimple/rollbar-api)
+# rollbar-api [![CircleCI](https://circleci.com/gh/wealthsimple/rollbar-api.svg?style=svg)](https://circleci.com/gh/wealthsimple/rollbar-api) [![](https://img.shields.io/gem/v/rollbar-api.svg)](https://rubygems.org/gems/rollbar-api)
 
 Rubygem for accessing Rollbar's full REST and RQL APIs.
 
+The [official rollbar rubygem](https://github.com/rollbar/rollbar-gem) only covers a small portion of the API, whereas this rubygem provides an interface over all API endpoints, including the Rollbar Query Language (RQL) endpoints.
+
+This gem aims to be future-compatible by not hard-coding any endpoints or request structures. See https://rollbar.com/docs/api/ for a full reference of all API requests and responses.
+
 ## Installation
 
 Add this line to your application's Gemfile and run `bundle` to install:
@@ -10,9 +14,9 @@ Add this line to your application's Gemfile and run `bundle` to install:
 gem 'rollbar-api'
 ```
 
-## Usage
+## Usage (Project-level APIs)
 
-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**.
+First, generate access tokens for each project you need access to by navigating to **Settings** > **Project Access Tokens** and clicking **Add new access token**. Unless you specifically need write access, it is recommended that you generate a read-only token.
 
 Next, configure each project:
 
@@ -21,11 +25,11 @@ Next, configure each 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"])
+RollbarApi::Project.configure("my-project", ENV["MY_PROJECT_ACCESS_TOKEN"])
+RollbarApi::Project.configure("other-project", ENV["OTHER_PROJECT_ACCESS_TOKEN"])
 ```
 
-### REST API
+### Making API Requests
 
 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:
 
@@ -42,6 +46,8 @@ top_items = RollbarApi::Project.find("my-project").get("/api/1/reports/top_activ
 })
 ```
 
+If you need to make an HTTP `POST`, `DELETE`, and so on, just replace `.get` with `.post`, `.delete`, and so forth.
+
 ### RQL Queries
 
 You can also run RQL queries:
@@ -62,7 +68,27 @@ if rql_job.result.status == "success"
 end
 ```
 
-See https://rollbar.com/docs/api/ for a full reference of API requests and responses.
+## Usage (Account-level APIs)
+
+First, generate access tokens for each account you need access to by navigating to https://rollbar.com/settings/accounts/ACCOUNT_NAME/access_tokens/ and clicking **Add new access token**. Unless you specifically need write access, it is recommended that you generate a read-only token.
+
+Next, configure each account:
+
+```ruby
+# config/initializers/rollbar-api.rb in a Rails project
+require 'rollbar-api'
+
+# Add as many accounts as you need (normally just one). Each should have a unique access token.
+RollbarApi::Account.configure("my-organization", ENV["ROLLBAR_ACCOUNT_ACCESS_TOKEN"])
+```
+
+### Making API Requests
+
+Making API requests through Account-level APIs works similarly to project-level API. Here's an example that fetches all Rollbar user details for your account:
+
+```ruby
+users = RollbarApi::Account.find("my-organization").get("/api/1/users")
+```
 
 ## Development
 

data/examples/list_account_users.rb

@@ -0,0 +1,14 @@
+require "dotenv/load"
+require "pp"
+require "bundler/setup"
+require "rollbar-api"
+
+account_name = ENV["ROLLBAR_ACCOUNT_NAME"] or raise "Must specify ROLLBAR_ACCOUNT_NAME in .env"
+account_access_token = ENV["ROLLBAR_ACCOUNT_ACCESS_TOKEN"] or raise "Must specify ROLLBAR_ACCOUNT_ACCESS_TOKEN in .env"
+
+RollbarApi::Account.configure(account_name, account_access_token)
+
+users = RollbarApi::Account.find(account_name).get("/api/1/users")
+users.result.users.each do |user|
+  p [user.username, user.email]
+end

data/examples/list_items.rb

@@ -6,7 +6,7 @@ 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)
+RollbarApi::Project.configure(project_name, project_access_token)
 
 # Fetch all items
 items = RollbarApi::Project.find(project_name).get("/api/1/items")

data/examples/rql_query.rb

@@ -6,7 +6,7 @@ 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)
+RollbarApi::Project.configure(project_name, project_access_token)
 
 # Create the job
 rql_job = RollbarApi::Project.find(project_name).post("/api/1/rql/jobs", {

data/examples/top_active_items.rb

@@ -6,7 +6,7 @@ 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)
+RollbarApi::Project.configure(project_name, project_access_token)
 
 top_active_items = RollbarApi::Project.find(project_name).get("/api/1/reports/top_active_items", {
   hours: "24",

data/lib/rollbar-api.rb

@@ -4,6 +4,7 @@ require "faraday"
 require "json"
 require "recursive-open-struct"
 
+require "rollbar-api/account"
 require "rollbar-api/project"
 require "rollbar-api/request"
 require "rollbar-api/resource"

data/lib/rollbar-api/account.rb

@@ -0,0 +1,40 @@
+module RollbarApi
+  class Account
+    @@accounts = {}
+
+    def self.configure(account_name, account_access_token)
+      @@accounts[account_name] = account_access_token
+    end
+
+    def self.find(account_name)
+      account_access_token = @@accounts[account_name]
+      new(account_name, account_access_token) if account_access_token.present?
+    end
+
+    def self.all
+      @@accounts.map { |account_name, _| find(account_name) }
+    end
+
+    def self.delete_all
+      @@accounts = {}
+    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/project.rb

@@ -2,7 +2,7 @@ module RollbarApi
   class Project
     @@projects = {}
 
-    def self.add(project_name, project_access_token)
+    def self.configure(project_name, project_access_token)
       @@projects[project_name] = project_access_token
     end
 

data/lib/rollbar-api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollbar-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Peter Graham
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-05 00:00:00.000000000 Z
+date: 2017-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -178,10 +178,12 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/list_account_users.rb
 - examples/list_items.rb
 - examples/rql_query.rb
 - examples/top_active_items.rb
 - lib/rollbar-api.rb
+- lib/rollbar-api/account.rb
 - lib/rollbar-api/project.rb
 - lib/rollbar-api/request.rb
 - lib/rollbar-api/resource.rb