rename Sentry => SentryApi

Author: thierryxing

README.md

@@ -15,7 +15,7 @@ gem 'sentry', :git => "[email protected]:thierryxing/sentry-ruby-api.git"
 Configuration example:
 
 ```ruby
-Sentry.configure do |config|
+SentryApi.configure do |config|
   config.endpoint = 'http://example.com/api/0'
   config.auth_token = 'your_auth_token'
   config.default_org_slug = 'sentry-sc'
@@ -28,26 +28,26 @@ Usage examples:
 
 ```ruby
 # set an API endpoint
-Sentry.endpoint = 'http://example.com/api/0'
+SentryApi.endpoint = 'http://example.com/api/0'
 # => "http://example.com/api/0"
 
 # set a user private token
-Sentry.auth_token = 'your_auth_token'
+SentryApi.auth_token = 'your_auth_token'
 # => "your_auth_token"
 
 # configure a proxy server
-Sentry.http_proxy('proxyhost', 8888)
+SentryApi.http_proxy('proxyhost', 8888)
 # proxy server w/ basic auth
-Sentry.http_proxy('proxyhost', 8888, 'user', 'pass')
+SentryApi.http_proxy('proxyhost', 8888, 'user', 'pass')
 
 # list projects
-Sentry.projects
+SentryApi.projects
 
 # initialize a new client
-s = Sentry.client(endpoint: 'https://api.example.com', auth_token: 'your_auth_token', default_org_slug: 'sentry-sc')
+s = SentryApi.client(endpoint: 'https://api.example.com', auth_token: 'your_auth_token', default_org_slug: 'sentry-sc')
 
 # a paginated response
-projects = Sentry.projects
+projects = SentryApi.projects
 
 # check existence of the next page
 projects.has_next_page?

bin/console

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

lib/sentry.rb lib/sentry-api.rblib/sentry.rb renamed to lib/sentry-api.rb

@@ -1,21 +1,21 @@
-require 'sentry/version'
-require 'sentry/objectified_hash'
-require 'sentry/configuration'
-require 'sentry/error'
-require 'sentry/page_links'
-require 'sentry/paginated_response'
-require 'sentry/request'
-require 'sentry/api'
-require 'sentry/client'
+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 Sentry
+module SentryApi
   extend Configuration
 
   # Alias for Sentry::Client.new
   #
   # @return [Sentry::Client]
   def self.client(options={})
-    Sentry::Client.new(options)
+    SentryApi::Client.new(options)
   end
 
   # Delegate to Sentry::Client
@@ -31,15 +31,15 @@ def respond_to_missing?(method_name, include_private = false)
 
   # Delegate to HTTParty.http_proxy
   def self.http_proxy(address=nil, port=nil, username=nil, password=nil)
-    Sentry::Request.http_proxy(address, port, username, password)
+    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/
-    (Sentry::Client.instance_methods - Object.methods).reject { |e| e[hidden] }
+    (SentryApi::Client.instance_methods - Object.methods).reject { |e| e[hidden] }
   end
 
 end

lib/sentry/api.rb lib/sentry-api/api.rblib/sentry/api.rb renamed to lib/sentry-api/api.rb

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

lib/sentry/client.rb lib/sentry-api/client.rblib/sentry/client.rb renamed to lib/sentry-api/client.rb

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

lib/sentry/client/events.rb lib/sentry-api/client/events.rblib/sentry/client/events.rb renamed to lib/sentry-api/client/events.rb

@@ -1,44 +1,44 @@
-class Sentry::Client
+class SentryApi::Client
 
   module Events
 
     # Retrieve an Issue
     #
     # @example
-    #   Sentry.issue('120732258')
+    #   SentryApi.issue('120732258')
     #
     # @param issue_id [String] the ID of the issue to retrieve.
-    # @return Sentry::ObjectifiedHash
+    # @return [SentryApi::ObjectifiedHash]
     def issue(issue_id)
       get("/issues/#{issue_id}/")
     end
 
     # List an Issue’s Events
     #
     # @example
-    #   Sentry.issue_events('120732258')
+    #   SentryApi.issue_events('120732258')
     #
     # @param issue_id [String] the ID of the issue to retrieve.
-    # @return [Array<Sentry::ObjectifiedHash>]
+    # @return [Array<SentryApi::ObjectifiedHash>]
     def issue_events(issue_id)
       get("/issues/#{issue_id}/events/")
     end
 
     # List an Issue’s Hashes
     #
     # @example
-    #   Sentry.issues_hashes('120732258')
+    #   SentryApi.issues_hashes('120732258')
     #
     # @param issue_id [String] the ID of the issue to retrieve.
-    # @return [Array<Sentry::ObjectifiedHash>]
+    # @return [Array<SentryApi::ObjectifiedHash>]
     def issue_hashes(issue_id)
       get("/issues/#{issue_id}/hashes/")
     end
 
     # Removes an individual issue.
     #
     # @example
-    #   Sentry.remove_issue('120732258')
+    #   SentryApi.remove_issue('120732258')
     #
     # @param issue_id [String] the ID of the issue to retrieve.
     def remove_issue(issue_id)
@@ -48,9 +48,9 @@ def remove_issue(issue_id)
     # Update an individual issue.
     #
     # @example
-    #   Sentry.update_issue('120732258')
-    #   Sentry.update_issue('120732258',{status:'resolved'})
-    #   Sentry.update_issue('120732258',{status:'resolved', assignedTo:'[email protected]'})
+    #   SentryApi.update_issue('120732258')
+    #   SentryApi.update_issue('120732258',{status:'resolved'})
+    #   SentryApi.update_issue('120732258',{status:'resolved', assignedTo:'[email protected]'})
     #
     # @param issue_id [String] the ID of the issue to retrieve.
     # @param  [Hash] options A customizable set of options.
@@ -59,28 +59,29 @@ def remove_issue(issue_id)
     # @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
-    #   Sentry.latest_event('120633628')
+    #   SentryApi.latest_event('120633628')
     #
     # @param issue_id [String] the ID of the issue to retrieve.
-    # @return Sentry::ObjectifiedHash
+    # @return [SentryApi::ObjectifiedHash]
     def latest_event(issue_id)
       get("/issues/#{issue_id}/events/latest/")
     end
 
     # Retrieves the details of the oldest event.
     #
     # @example
-    #   Sentry.oldest_event('120633628')
+    #   SentryApi.oldest_event('120633628')
     #
     # @param issue_id [String] the ID of the issue to retrieve.
-    # @return Sentry::ObjectifiedHash
+    # @return [SentryApi::ObjectifiedHash]
     def oldest_event(issue_id)
       get("/issues/#{issue_id}/events/oldest/")
     end

lib/sentry/client/organizations.rb lib/sentry-api/client/organizations.rblib/sentry/client/organizations.rb renamed to lib/sentry-api/client/organizations.rb

@@ -1,25 +1,25 @@
-class Sentry::Client
+class SentryApi::Client
 
   module Organizations
     # List your Organizations.
     #
     # @example
-    #   Sentry.organizations
+    #   SentryApi.organizations
     #
     # @param member [Boolean] Restrict results to organizations which you have membership
-    # @return [Array<Sentry::ObjectifiedHash>]
+    # @return [Array<SentryApi::ObjectifiedHash>]
     def organizations(member=false)
       get("/organizations/", query: {member: member})
     end
 
     # List an Organization’s Projects
     #
     # @example
-    #   Sentry.organization_projects
-    #   Sentry.organization_projects('slug')
+    #   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<Sentry::ObjectifiedHash>]
+    # @return [Array<SentryApi::ObjectifiedHash>]
     def organization_projects(organization_slug="")
       organization_slug = @default_org_slug if organization_slug == ""
       get("/organizations/#{organization_slug}/projects/")
@@ -28,11 +28,11 @@ def organization_projects(organization_slug="")
     # Retrieve an Organization
     #
     # @example
-    #   Sentry.organization
-    #   Sentry.organization('slug')
+    #   SentryApi.organization
+    #   SentryApi.organization('slug')
     #
     # @param organization_slug [String] the slug of the organization the team should be created for.
-    # @return Sentry::ObjectifiedHash
+    # @return [SentryApi::ObjectifiedHash]
     def organization(organization_slug="")
       organization_slug = @default_org_slug if organization_slug == ""
       get("/organizations/#{organization_slug}/")
@@ -41,24 +41,24 @@ def organization(organization_slug="")
     # Update an Organization
     #
     # @example
-    #   Sentry.update_organization('slug')
-    #   Sentry.update_organization('slug',{name:'new-name'})
-    #   Sentry.update_organization('slug',{name:'new-name', slug:'new-slug'})
+    #   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 Sentry::ObjectifiedHash
+    # @return [SentryApi::ObjectifiedHash]
     def update_organization(organization_slug, options={})
       put("/organizations/#{organization_slug}/", body: options)
     end
 
     # Retrieve Event Counts for an Organization
     #
     # @example
-    #   Sentry.organization_stats('slug')
-    #   Sentry.organization_stats('slug', {stat:'received', since:'1472158800'})
+    #   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.