sentry-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 63d5a7432a7a86a1c8077fb4d702701632640a76
+  data.tar.gz: 7aee07004fab408b8a662e3ed394090408ecbdda
+SHA512:
+  metadata.gz: ada67008ed2eaa102a87ff5b2e3bd370aaf57f408371261149984e8f4f220319c68c28180ca691958b2cba5911d67fa25366b1f8bce132b480fe7a9f1b9a2517
+  data.tar.gz: 31879008fa89a01e1601f19dc0fc0754b5677a5b726bfefcf745efa20815b7b53a946be315baf090c7d2661e0ebe5e9835e04ea1c9c3e741c4130fa96fb41de4

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/test/
+*.gem

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2015-2016 Thierry Xing <thierry.xing@gmail.com>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,82 @@
+# Sentry Ruby API
+[![Build Status](https://travis-ci.org/thierryxing/sentry-ruby-api.svg?branch=master)](https://travis-ci.org/thierryxing/sentry-ruby-api)
+[![License](https://img.shields.io/badge/license-BSD-red.svg?style=flat)](https://github.com/thierryxing/sentry-ruby-api/blob/master/LICENSE.txt)
+
+Sentry Ruby API is a Ruby wrapper for the [getsentry/sentry API](https://docs.sentry.io/hosted/api/). 
+
+
+## Installation
+
+add to a Gemfile:
+
+```ruby
+gem 'sentry', :git => "git@github.com:thierryxing/sentry-ruby-api.git"
+```
+
+## Usage
+
+Configuration example:
+
+```ruby
+SentryApi.configure do |config|
+  config.endpoint = 'http://example.com/api/0'
+  config.auth_token = 'your_auth_token'
+  config.default_org_slug = 'sentry-sc'
+end
+```
+
+(Note: If you are using getsentry.com's hosted service, your endpoint will be `https://app.getsentry.com/api/0`)
+
+Usage examples:
+
+```ruby
+# set an API endpoint
+SentryApi.endpoint = 'http://example.com/api/0'
+# => "http://example.com/api/0"
+
+# set a user private token
+SentryApi.auth_token = 'your_auth_token'
+# => "your_auth_token"
+
+# configure a proxy server
+SentryApi.http_proxy('proxyhost', 8888)
+# proxy server w/ basic auth
+SentryApi.http_proxy('proxyhost', 8888, 'user', 'pass')
+
+# list projects
+SentryApi.projects
+
+# initialize a new client
+s = SentryApi.client(endpoint: 'https://api.example.com', auth_token: 'your_auth_token', default_org_slug: 'sentry-sc')
+
+# a paginated response
+projects = SentryApi.projects
+
+# check existence of the next page
+projects.has_next_page?
+
+# retrieve the next page
+projects.next_page
+
+# iterate all projects
+projects.auto_paginate do |project|
+  # do something
+end
+
+# retrieve all projects as an array
+projects.auto_paginate
+```
+
+## Development
+The basic framework had been finished, meanwhile the APIs of Organizations,Projects and Events had been added, more APIs will be added later. You are welcome to help me with it.
+
+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.
+
+## License
+
+Released under the BSD 2-clause license. See LICENSE.txt for details.
+
+## Special Thank
+Thanks to NARKOZ's [gitlab](https://github.com/NARKOZ/gitlab) ruby wrapper which really gives me a lot of inspiration.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sentry-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/sentry-api.rb

@@ -0,0 +1,45 @@
+require 'sentry-api/version'
+require 'sentry-api/objectified_hash'
+require 'sentry-api/configuration'
+require 'sentry-api/error'
+require 'sentry-api/page_links'
+require 'sentry-api/paginated_response'
+require 'sentry-api/request'
+require 'sentry-api/api'
+require 'sentry-api/client'
+
+module SentryApi
+  extend Configuration
+
+  # Alias for Sentry::Client.new
+  #
+  # @return [Sentry::Client]
+  def self.client(options={})
+    SentryApi::Client.new(options)
+  end
+
+  # Delegate to Sentry::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Sentry::Client
+  def respond_to_missing?(method_name, include_private = false)
+    client.respond_to?(method_name) || super
+  end
+
+  # Delegate to HTTParty.http_proxy
+  def self.http_proxy(address=nil, port=nil, username=nil, password=nil)
+    SentryApi::Request.http_proxy(address, port, username, password)
+  end
+
+  # Returns an unsorted array of available client methods.
+  #
+  # @return [Array<Symbol>]
+  def self.actions
+    hidden = /endpoint|auth_token|default_org_slug|get|post|put|delete|validate|set_request_defaults|httparty/
+    (SentryApi::Client.instance_methods - Object.methods).reject { |e| e[hidden] }
+  end
+
+end

data/lib/sentry-api/api.rb

@@ -0,0 +1,17 @@
+module SentryApi
+  # @private
+  class API < Request
+    # @private
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    # Creates a new API.
+    # @raise [Error:MissingCredentials]
+    def initialize(options={})
+      options = SentryApi.options.merge(options)
+      (Configuration::VALID_OPTIONS_KEYS).each do |key|
+        send("#{key}=", options[key]) if options[key]
+      end
+      set_request_defaults
+    end
+  end
+end

data/lib/sentry-api/client.rb

@@ -0,0 +1,10 @@
+module SentryApi
+  # Wrapper for the Sentry REST API.
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
+
+    include Organizations
+    include Projects
+    include Events
+  end
+end

data/lib/sentry-api/client/events.rb

@@ -0,0 +1,91 @@
+class SentryApi::Client
+
+  module Events
+
+    # Retrieve an Issue
+    #
+    # @example
+    #   SentryApi.issue('120732258')
+    #
+    # @param issue_id [String] the ID of the issue to retrieve.
+    # @return [SentryApi::ObjectifiedHash]
+    def issue(issue_id)
+      get("/issues/#{issue_id}/")
+    end
+
+    # List an Issue’s Events
+    #
+    # @example
+    #   SentryApi.issue_events('120732258')
+    #
+    # @param issue_id [String] the ID of the issue to retrieve.
+    # @return [Array<SentryApi::ObjectifiedHash>]
+    def issue_events(issue_id)
+      get("/issues/#{issue_id}/events/")
+    end
+
+    # List an Issue’s Hashes
+    #
+    # @example
+    #   SentryApi.issues_hashes('120732258')
+    #
+    # @param issue_id [String] the ID of the issue to retrieve.
+    # @return [Array<SentryApi::ObjectifiedHash>]
+    def issue_hashes(issue_id)
+      get("/issues/#{issue_id}/hashes/")
+    end
+
+    # Removes an individual issue.
+    #
+    # @example
+    #   SentryApi.remove_issue('120732258')
+    #
+    # @param issue_id [String] the ID of the issue to retrieve.
+    def remove_issue(issue_id)
+      delete("/issues/#{issue_id}/")
+    end
+
+    # Update an individual issue.
+    #
+    # @example
+    #   SentryApi.update_issue('120732258')
+    #   SentryApi.update_issue('120732258',{status:'resolved'})
+    #   SentryApi.update_issue('120732258',{status:'resolved', assignedTo:'thierry.xing@gmail.com'})
+    #
+    # @param issue_id [String] the ID of the issue to retrieve.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :status the new status for the groups. Valid values are "resolved", "unresolved" and "muted".
+    # @option options [String] :assignedTo the username of the user that should be assigned to this issue.
+    # @option options [Boolean] :hasSeen in case this API call is invoked with a user context this allows changing of the flag that indicates if the user has seen the event.
+    # @option options [Boolean] :isBookmarked in case this API call is invoked with a user context this allows changing of the bookmark flag.
+    # @option options [Boolean] :isSubscribed in case this API call is invoked with a user context this allows changing of the subscribed flag.
+    # @return <SentryApi::ObjectifiedHash>
+    def update_issue(issue_id, options={})
+      put("/issues/#{issue_id}/", body: options)
+    end
+
+    # Retrieves the details of the latest event.
+    #
+    # @example
+    #   SentryApi.latest_event('120633628')
+    #
+    # @param issue_id [String] the ID of the issue to retrieve.
+    # @return [SentryApi::ObjectifiedHash]
+    def latest_event(issue_id)
+      get("/issues/#{issue_id}/events/latest/")
+    end
+
+    # Retrieves the details of the oldest event.
+    #
+    # @example
+    #   SentryApi.oldest_event('120633628')
+    #
+    # @param issue_id [String] the ID of the issue to retrieve.
+    # @return [SentryApi::ObjectifiedHash]
+    def oldest_event(issue_id)
+      get("/issues/#{issue_id}/events/oldest/")
+    end
+
+  end
+
+end

data/lib/sentry-api/client/organizations.rb

@@ -0,0 +1,76 @@
+class SentryApi::Client
+
+  module Organizations
+    # List your Organizations.
+    #
+    # @example
+    #   SentryApi.organizations
+    #
+    # @param member [Boolean] Restrict results to organizations which you have membership
+    # @return [Array<SentryApi::ObjectifiedHash>]
+    def organizations(member=false)
+      get("/organizations/", query: {member: member})
+    end
+
+    # List an Organization’s Projects
+    #
+    # @example
+    #   SentryApi.organization_projects
+    #   SentryApi.organization_projects('slug')
+    #
+    # @param organization_slug [String] the slug of the organization for which the projects should be listed.
+    # @return [Array<SentryApi::ObjectifiedHash>]
+    def organization_projects(organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      get("/organizations/#{organization_slug}/projects/")
+    end
+
+    # Retrieve an Organization
+    #
+    # @example
+    #   SentryApi.organization
+    #   SentryApi.organization('slug')
+    #
+    # @param organization_slug [String] the slug of the organization the team should be created for.
+    # @return [SentryApi::ObjectifiedHash]
+    def organization(organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      get("/organizations/#{organization_slug}/")
+    end
+
+    # Update an Organization
+    #
+    # @example
+    #   SentryApi.update_organization('slug')
+    #   SentryApi.update_organization('slug',{name:'new-name'})
+    #   SentryApi.update_organization('slug',{name:'new-name', slug:'new-slug'})
+    #
+    # @param organization_slug [String] the slug of the organization the team should be created for.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :name an optional new name for the organization.
+    # @option options [String] :slug an optional new slug for the organization. Needs to be available and unique.
+    # @return [SentryApi::ObjectifiedHash]
+    def update_organization(organization_slug, options={})
+      put("/organizations/#{organization_slug}/", body: options)
+    end
+
+    # Retrieve Event Counts for an Organization
+    #
+    # @example
+    #   SentryApi.organization_stats('slug')
+    #   SentryApi.organization_stats('slug', {stat:'received', since:'1472158800'})
+    #
+    # @param organization_slug [String] the slug of the organization for which the stats should be retrieved.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :stat the name of the stat to query ("received", "rejected", "blacklisted")
+    # @option options [Timestamp] :since a timestamp to set the start of the query in seconds since UNIX epoch.
+    # @option options [Timestamp] :until a timestamp to set the end of the query in seconds since UNIX epoch.
+    # @option options [String] :resolution an explicit resolution to search for (eg: 10s). This should not be used unless you are familiar with Sentry’s internals as it’s restricted to pre-defined values.
+    # @return [Array<Array>]
+    def organization_stats(organization_slug, options={})
+      get("/organizations/#{organization_slug}/stats/", query: options)
+    end
+
+  end
+
+end

data/lib/sentry-api/client/projects.rb

@@ -0,0 +1,185 @@
+class SentryApi::Client
+
+  module Projects
+    # List your Projects
+    #
+    # @example
+    #   SentryApi.projects
+    #
+    # @return [Array<SentryApi::ObjectifiedHash>]
+    def projects
+      get("/projects/")
+    end
+
+    # Retrieve a Project
+    #
+    # @example
+    #   SentryApi.project('project-slug')
+    #
+    # @param project_slug [String] the slug of the project to retrieve.
+    # @param organization_slug [String] the slug of the organization the project belong to.
+    # @return [SentryApi::ObjectifiedHash]
+    def project(project_slug, organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      get("/projects/#{organization_slug}/#{project_slug}/")
+    end
+
+    # Update a Project
+    #
+    # @example
+    #   SentryApi.update_project('project-slug', {name:'new-name', slug:'new-slug', is_bookmarked:false})
+    #
+    # @param project_slug [String] the slug of the project to retrieve.
+    # @param  [Hash] options A customizable set of options.
+    # @option options [String] :name the new name for the project.
+    # @option options [String] :slug the new slug for the project.
+    # @option options [String] :isBookmarked in case this API call is invoked with a user context this allows changing of the bookmark flag.
+    # @option options [Hash] optional options to override in the project settings.
+    # @param organization_slug [String] the slug of the organization the project belong to.
+    # @return [SentryApi::ObjectifiedHash]
+    def update_project(project_slug, options={}, organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      put("/projects/#{organization_slug}/#{project_slug}/", body: options)
+    end
+
+    # Delete a Project.
+    #
+    # @example
+    #   SentryApi.delete_project('project-slug')
+    #
+    # @param project_slug [String] the slug of the project to delete.
+    # @param organization_slug [String] the slug of the organization the project belong to.
+    def delete_project(project_slug, organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      delete("/projects/#{organization_slug}/#{project_slug}/")
+    end
+
+    # Retrieve Event Counts for an Project
+    #
+    # @example
+    #   SentryApi.project_stats('slug')
+    #   SentryApi.project_stats('slug', {stat:'received', since:'1472158800'})
+    #
+    # @param project_slug [String] the slug of the project.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :stat the name of the stat to query ("received", "rejected", "blacklisted")
+    # @option options [Timestamp] :since a timestamp to set the start of the query in seconds since UNIX epoch.
+    # @option options [Timestamp] :until a timestamp to set the end of the query in seconds since UNIX epoch.
+    # @option options [String] :resolution an explicit resolution to search for (eg: 10s). This should not be used unless you are familiar with Sentry’s internals as it’s restricted to pre-defined values.
+    # @param organization_slug [String] the slug of the organization the project belong to.
+    # @return [Array<Array>]
+    def project_stats(project_slug, options={}, organization_slug="")
+      get("/projects/#{organization_slug}/#{project_slug}/stats/", query: options)
+    end
+
+    # List a Project’s DSym Files.
+    #
+    # @example
+    #   SentryApi.project_dsym_files('project-slug')
+    #
+    # @param organization_slug [String] the slug of the organization.
+    # @param project_slug [String] the slug of the project to list the dsym files of.
+    # @return [Array<SentryApi::ObjectifiedHash>]
+    def project_dsym_files(project_slug, organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      get("/projects/#{organization_slug}/#{project_slug}/files/dsyms/")
+    end
+
+    # List a Project’s Client Keys.
+    #
+    # @example
+    #   SentryApi.client_keys('project-slug')
+    #
+    # @param project_slug [String] the slug of the project the client keys belong to.
+    # @param organization_slug [String] the slug of the organization the client keys belong to.
+    # @return [Array<SentryApi::ObjectifiedHash>]
+    def client_keys(project_slug, organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      get("/projects/#{organization_slug}/#{project_slug}/keys/")
+    end
+
+    # Create a new Client Key.
+    #
+    # @example
+    #   SentryApi.create_client_key('project-slug','new-name')
+    #
+    # @param project_slug [String] the slug of the project the client keys belong to.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :name the name for the new key.
+    # @param organization_slug [String] the slug of the organization the client keys belong to.
+    # @return [SentryApi::ObjectifiedHash]
+    def create_client_key(project_slug, options={}, organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      post("/projects/#{organization_slug}/#{project_slug}/keys/", body: options)
+    end
+
+    # Delete a Client Key.
+    #
+    # @example
+    #   SentryApi.delete_client_key('project-slug','87c990582e07446b9907b357fc27730e')
+    #
+    # @param project_slug [String] the slug of the project the client keys belong to.
+    # @param key_id [String] the ID of the key to delete.
+    # @param organization_slug [String] the slug of the organization the client keys belong to.
+    def delete_client_key(project_slug, key_id, organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      delete("/projects/#{organization_slug}/#{project_slug}/keys/#{key_id}/")
+    end
+
+    # Update a Client Key
+    #
+    # @example
+    #   SentryApi.update_client_key('project-slug','87c990582e07446b9907b357fc27730e',{name:'new-name'})
+    #
+    # @param project_slug [String] the slug of the project the client keys belong to.
+    # @param key_id [String] the ID of the key to update.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :name the new name for the client key.
+    # @param organization_slug [String] the slug of the organization the client keys belong to.
+    # @return [Array<SentryApi::ObjectifiedHash>]
+    def update_client_key(project_slug, key_id, options={}, organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      put("/projects/#{organization_slug}/#{project_slug}/keys/#{key_id}/", body: options)
+    end
+
+    # Return a list of sampled events bound to a project.
+    #
+    # @example
+    #   SentryApi.project_events('project-slug')
+    #
+    # @param project_slug [String] the slug of the project the client keys belong to.
+    # @param organization_slug [String] the slug of the organization the client keys belong to.
+    # @return [Array<SentryApi::ObjectifiedHash>]
+    def project_events(project_slug, organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      get("/projects/#{organization_slug}/#{project_slug}/events/")
+    end
+
+    # Retrieve an Event for a Project
+    #
+    # @example
+    #   SentryApi.project_event('project-slug', 'event-id')
+    #
+    # @param project_slug [String] the slug of the project the client keys belong to.
+    # @param event_id [String] the slug of the project the event belongs to.
+    # @param organization_slug [String] the slug of the organization the client keys belong to.
+    # @return [SentryApi::ObjectifiedHash]
+    def project_event(project_slug, event_id, organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      get("/projects/#{organization_slug}/#{project_slug}/events/#{event_id}/")
+    end
+
+    # Return a list of aggregates bound to a project
+    #
+    # @example
+    #   SentryApi.project_issues('project-slug')
+    #
+    # @return [Array<SentryApi::ObjectifiedHash>]
+    def project_issues(project_slug, organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      get("/projects/#{organization_slug}/#{project_slug}/issues/")
+    end
+
+  end
+
+end

data/lib/sentry-api/client/teams.rb

@@ -0,0 +1,24 @@
+class SentryApi::Client
+
+  module Teams
+
+    # Create a new project bound to a team.
+    #
+    # @example
+    #   SentryApi.create_project('team-slug',{name:'new-name'})
+    #
+    # @param team_slug [String] the slug of the team to create a new project for.
+    # @param organization_slug [String]  the slug of the organization the team belongs to.
+    # @param [Hash] options A customizable set of options.
+    # @option options [String] :name the name for the new project.
+    # @option options [String] :slug optionally a slug for the new project. If it’s not provided a slug is generated from the name.
+    # @return [SentryApi::ObjectifiedHash]
+    def create_project(team_slug, options={}, organization_slug="")
+      organization_slug = @default_org_slug if organization_slug == ""
+      post("/teams/#{organization_slug}/#{team_slug}/projects/", body: options)
+    end
+
+
+  end
+
+end

data/lib/sentry-api/configuration.rb

@@ -0,0 +1,39 @@
+module SentryApi
+  # Defines constants and methods related to configuration.
+  module Configuration
+    # An array of valid keys in the options hash when configuring a Sentry::API.
+    VALID_OPTIONS_KEYS = [:endpoint, :auth_token, :default_org_slug, :httparty].freeze
+
+    # The user agent that will be sent to the API endpoint if none is set.
+    DEFAULT_USER_AGENT = "Sentry Ruby Gem #{SentryApi::VERSION}".freeze
+
+    # @private
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    # Sets all configuration options to their default values
+    # when this module is extended.
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block.
+    def configure
+      yield self
+    end
+
+    # Creates a hash of options and their values.
+    def options
+      VALID_OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    # Resets all configuration options to the defaults.
+    def reset
+      self.endpoint = ENV['SENTRY_API_ENDPOINT']
+      self.auth_token = ENV['SENTRY_API_AUTH_TOKEN']
+      self.default_org_slug = ENV['SENTRY_API_DEFAULT_ORG_SLUG']
+    end
+
+  end
+end

data/lib/sentry-api/error.rb

@@ -0,0 +1,98 @@
+module SentryApi
+  module Error
+    # Custom error class for rescuing from all Sentry errors.
+    class Error < StandardError;
+    end
+
+    # Raised when API endpoint credentials not configured.
+    class MissingCredentials < Error;
+    end
+
+    # Raised when impossible to parse response body.
+    class Parsing < Error;
+    end
+
+    # Custom error class for rescuing from HTTP response errors.
+    class ResponseError < Error
+      def initialize(response)
+        @response = response
+        super(build_error_message)
+      end
+
+      # Status code returned in the http response.
+      #
+      # @return [Integer]
+      def response_status
+        @response.code
+      end
+
+      private
+
+      # Human friendly message.
+      #
+      # @return [String]
+      def build_error_message
+        parsed_response = @response.parsed_response
+        message = parsed_response.message || parsed_response.error
+
+        "Server responded with code #{@response.code}, message: " \
+        "#{handle_message(message)}. " \
+        "Request URI: #{@response.request.base_uri}#{@response.request.path}"
+      end
+
+      # Handle error response message in case of nested hashes
+      def handle_message(message)
+        case message
+          when SentryApi::ObjectifiedHash
+            message.to_h.sort.map do |key, val|
+              "'#{key}' #{(val.is_a?(Hash) ? val.sort.map { |k, v| "(#{k}: #{v.join(' ')})" } : val).join(' ')}"
+            end.join(', ')
+          when Array
+            message.join(' ')
+          else
+            message
+        end
+      end
+    end
+
+    # Raised when API endpoint returns the HTTP status code 400.
+    class BadRequest < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 401.
+    class Unauthorized < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 403.
+    class Forbidden < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 404.
+    class NotFound < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 405.
+    class MethodNotAllowed < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 409.
+    class Conflict < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 422.
+    class Unprocessable < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 500.
+    class InternalServerError < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 502.
+    class BadGateway < ResponseError;
+    end
+
+    # Raised when API endpoint returns the HTTP status code 503.
+    class ServiceUnavailable < ResponseError;
+    end
+  end
+end

data/lib/sentry-api/objectified_hash.rb

@@ -0,0 +1,35 @@
+module SentryApi
+  # Converts hashes to the objects.
+  class ObjectifiedHash
+    # Creates a new ObjectifiedHash object.
+    def initialize(hash)
+      @hash = hash
+      @data = hash.inject({}) do |data, (key, value)|
+        value = ObjectifiedHash.new(value) if value.is_a? Hash
+        data[key.to_s] = value
+        data
+      end
+    end
+
+    # @return [Hash] The original hash.
+    def to_hash
+      @hash
+    end
+
+    alias_method :to_h, :to_hash
+
+    # @return [String] Formatted string with the class name, object id and original hash.
+    def inspect
+      "#<#{self.class}:#{object_id} {hash: #{@hash.inspect}}"
+    end
+
+    # Delegate to ObjectifiedHash.
+    def method_missing(key)
+      @data.key?(key.to_s) ? @data[key.to_s] : nil
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @hash.keys.map(&:to_sym).include?(method_name.to_sym) || super
+    end
+  end
+end

data/lib/sentry-api/page_links.rb

@@ -0,0 +1,33 @@
+module SentryApi
+  # Parses link header.
+  #
+  # @private
+  class PageLinks
+    HEADER_LINK = 'Link'.freeze
+    DELIM_LINKS = ','.freeze
+    LINK_REGEX = /<([^>]+)>; rel=\"([^\"]+)\"; results=\"([^\"]+)\"/
+    METAS = %w(previous next)
+
+    attr_accessor(*METAS)
+
+    def initialize(headers)
+      link_header = headers[HEADER_LINK]
+
+      if link_header && link_header =~ /(previous|next)/
+        extract_links(link_header)
+      end
+    end
+
+    private
+
+    def extract_links(header)
+      header.split(DELIM_LINKS).each do |link|
+        LINK_REGEX.match(link.strip) do |match|
+          url, meta, results = match[1], match[2], match[3]
+          next if !url or !meta or !(results == "true") or METAS.index(meta).nil?
+          self.send("#{meta}=", url)
+        end
+      end
+    end
+  end
+end

data/lib/sentry-api/paginated_response.rb

@@ -0,0 +1,75 @@
+module SentryApi
+  # Wrapper class of paginated response.
+  class PaginatedResponse
+    attr_accessor :client
+
+    def initialize(array)
+      @array = array
+    end
+
+    def ==(other)
+      @array == other
+    end
+
+    def inspect
+      @array.inspect
+    end
+
+    def method_missing(name, *args, &block)
+      if @array.respond_to?(name)
+        @array.send(name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      super || @array.respond_to?(method_name, include_private)
+    end
+
+    def parse_headers!(headers)
+      @links = PageLinks.new headers
+    end
+
+    def each_page
+      current = self
+      yield current
+      while current.has_next_page?
+        current = current.next_page
+        yield current
+      end
+    end
+
+    def auto_paginate
+      response = block_given? ? nil : []
+      each_page do |page|
+        if block_given?
+          page.each do |item|
+            yield item
+          end
+        else
+          response += page
+        end
+      end
+      response
+    end
+
+    def has_next_page?
+      !(@links.nil? || @links.next.nil?)
+    end
+
+    def next_page
+      return nil if @client.nil? || !has_next_page?
+      @links.next
+    end
+
+    def has_prev_page?
+      !(@links.nil? || @links.previous.nil?)
+    end
+
+    def prev_page
+      return nil if @client.nil? || !has_prev_page?
+      @links.previous
+    end
+  end
+end

data/lib/sentry-api/request.rb

@@ -0,0 +1,133 @@
+require 'httparty'
+require 'json'
+
+module SentryApi
+  # @private
+  class Request
+    include HTTParty
+    format :json
+    headers 'Content-Type' => 'application/json'
+    parser proc { |body, _| parse(body) }
+
+    attr_accessor :auth_token, :endpoint, :default_org_slug
+
+    # Converts the response body to an ObjectifiedHash.
+    def self.parse(body)
+      body = decode(body)
+
+      if body.is_a? Hash
+        ObjectifiedHash.new body
+      elsif body.is_a? Array
+        if body[0].is_a? Array
+          body
+        else
+          PaginatedResponse.new(body.collect! { |e| ObjectifiedHash.new(e) })
+        end
+      elsif body
+        true
+      elsif !body
+        false
+      elsif body.nil?
+        false
+      else
+        raise Error::Parsing.new "Couldn't parse a response body"
+      end
+    end
+
+    # Decodes a JSON response into Ruby object.
+    def self.decode(response)
+      JSON.load response
+    rescue JSON::ParserError
+      raise Error::Parsing.new "The response is not a valid JSON"
+    end
+
+    def get(path, options={})
+      set_httparty_config(options)
+      set_authorization_header(options)
+      validate self.class.get(@endpoint + path, options)
+    end
+
+    def post(path, options={})
+      set_httparty_config(options)
+      set_json_body(options)
+      set_authorization_header(options, path)
+      validate self.class.post(@endpoint + path, options)
+    end
+
+    def put(path, options={})
+      set_httparty_config(options)
+      set_json_body(options)
+      set_authorization_header(options)
+      validate self.class.put(@endpoint + path, options)
+    end
+
+    def delete(path, options={})
+      set_httparty_config(options)
+      set_authorization_header(options)
+      validate self.class.delete(@endpoint + path, options)
+    end
+
+    # Checks the response code for common errors.
+    # Returns parsed response for successful requests.
+    def validate(response)
+      error_klass = case response.code
+                      when 400 then
+                        Error::BadRequest
+                      when 401 then
+                        Error::Unauthorized
+                      when 403 then
+                        Error::Forbidden
+                      when 404 then
+                        Error::NotFound
+                      when 405 then
+                        Error::MethodNotAllowed
+                      when 409 then
+                        Error::Conflict
+                      when 422 then
+                        Error::Unprocessable
+                      when 500 then
+                        Error::InternalServerError
+                      when 502 then
+                        Error::BadGateway
+                      when 503 then
+                        Error::ServiceUnavailable
+                    end
+
+      fail error_klass.new(response) if error_klass
+
+      parsed = response.parsed_response
+      parsed.client = self if parsed.respond_to?(:client=)
+      parsed.parse_headers!(response.headers) if parsed.respond_to?(:parse_headers!)
+      parsed
+    end
+
+    # Sets a base_uri and default_params for requests.
+    # @raise [Error::MissingCredentials] if endpoint not set.
+    def set_request_defaults
+      self.class.default_params
+      raise Error::MissingCredentials.new("Please set an endpoint to API") unless @endpoint
+    end
+
+    private
+
+    # Sets a Authorization header for requests.
+    # @raise [Error::MissingCredentials] if auth_token and auth_token are not set.
+    def set_authorization_header(options, path=nil)
+      unless path == '/session'
+        raise Error::MissingCredentials.new("Please provide a auth_token for user") unless @auth_token
+        options[:headers] = {'Authorization' => "Bearer #{@auth_token}"}
+      end
+    end
+
+    # Set http post or put body as json string
+    def set_json_body(options)
+      options[:body] = options[:body].to_json
+    end
+
+    # Set HTTParty configuration
+    # @see https://github.com/jnunemaker/httparty
+    def set_httparty_config(options)
+      options.merge!(httparty) if httparty
+    end
+  end
+end

data/lib/sentry-api/version.rb

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

data/sentry-api.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sentry-api/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "sentry-api"
+  spec.version = SentryApi::VERSION
+  spec.authors = ["Thierry Xing"]
+  spec.email = ["thierry.xing@gmail.com"]
+  spec.licenses = ['MIT']
+  spec.summary = %q{Ruby client for Sentry API}
+  spec.description = %q{A Ruby wrapper for the Sentry API}
+  spec.homepage = "https://github.com/thierryxing/sentry-ruby-api"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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_runtime_dependency 'httparty', "~> 0.14.0"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', "~> 3.5.0", '>= 3.5.0'
+  spec.add_development_dependency 'webmock', "~> 2.1.0", '>= 2.1.0'
+  spec.add_development_dependency 'yard', "~> 0.9.5"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: sentry-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thierry Xing
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+description: A Ruby wrapper for the Sentry API
+email:
+- thierry.xing@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sentry-api.rb
+- lib/sentry-api/api.rb
+- lib/sentry-api/client.rb
+- lib/sentry-api/client/events.rb
+- lib/sentry-api/client/organizations.rb
+- lib/sentry-api/client/projects.rb
+- lib/sentry-api/client/teams.rb
+- lib/sentry-api/configuration.rb
+- lib/sentry-api/error.rb
+- lib/sentry-api/objectified_hash.rb
+- lib/sentry-api/page_links.rb
+- lib/sentry-api/paginated_response.rb
+- lib/sentry-api/request.rb
+- lib/sentry-api/version.rb
+- sentry-api.gemspec
+homepage: https://github.com/thierryxing/sentry-ruby-api
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Ruby client for Sentry API
+test_files: []