finish events and issues apis

Author: thierryxing

README.md

@@ -1,79 +1,36 @@
-# Sentry Ruby API
+# Sentry
 
-Sentry Ruby API is a Ruby wrapper for the [getsentry/sentry API](https://docs.sentry.io/hosted/api/). **And it still being developed, and not published yet.**
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sentry`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-## Installation
-
-add to a Gemfile:
-
-```ruby
-gem 'sentry', :path => '/path/to/sentry'
-```
+TODO: Delete this and the text above, and describe your gem
 
-## Usage
+## Installation
 
-Configuration example:
+Add this line to your application's Gemfile:
 
 ```ruby
-Sentry.configure do |config|
-  config.endpoint = 'http://example.com/api/0'
-  config.auth_token = 'your_auth_token'
-  config.default_org_slug = 'sentry-sc'
-end
+gem 'sentry'
 ```
 
-(Note: If you are using getsentry.com's hosted service, your endpoint will be `https://app.getsentry.com/api/0`)
+And then execute:
 
-Usage examples:
-
-```ruby
-# set an API endpoint
-Sentry.endpoint = 'http://example.com/api/0'
-# => "http://example.com/api/0"
+    $ bundle
 
-# set a user private token
-Sentry.auth_token = 'your_auth_token'
-# => "your_auth_token"
+Or install it yourself as:
 
-# configure a proxy server
-Sentry.http_proxy('proxyhost', 8888)
-# proxy server w/ basic auth
-Sentry.http_proxy('proxyhost', 8888, 'user', 'pass')
+    $ gem install sentry
 
-# list projects
-Sentry.projects
-
-# initialize a new client
-s = Sentry.client(endpoint: 'https://api.example.com', auth_token: 'your_auth_token', default_org_slug: 'sentry-sc')
-
-# a paginated response
-projects = Sentry.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
+## Usage
 
-# retrieve all projects as an array
-projects.auto_paginate
-```
+TODO: Write usage instructions here
 
 ## Development
-The basic framework had been finished, meanwhile the APIs of Organizations and Projects 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.
+After checking out the repo, run `bin/setup` to install dependencies. 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).
 
-## License
+## Contributing
 
-Released under the BSD 2-clause license. See LICENSE.txt for details.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sentry.
 
-## Special Thank
-Thanks to NARKOZ's [gitlab](https://github.com/NARKOZ/gitlab) ruby wrapper which really gives me a lot of inspiration.

Rakefile

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

lib/sentry/client.rb

@@ -5,5 +5,6 @@ class Client < API
 
     include Organizations
     include Projects
+    include Events
   end
 end

lib/sentry/client/events.rb

@@ -2,59 +2,87 @@ class Sentry::Client
 
   module Events
 
-    # Return details on an individual issue.
-    def issue
+    # Retrieve an Issue
+    #
+    # @example
+    #   Sentry.issue('120732258')
+    #
+    # @param issue_id [String] the ID of the issue to retrieve.
+    # @return Sentry::ObjectifiedHash
+    def issue(issue_id)
+      get("/issues/#{issue_id}/")
     end
 
-    # Return a list of aggregates bound to a project
+    # List an Issue’s Events
     #
     # @example
-    #   Sentry.projects
+    #   Sentry.issue_events('120732258')
     #
+    # @param issue_id [String] the ID of the issue to retrieve.
     # @return [Array<Sentry::ObjectifiedHash>]
-    def issues
+    def issue_events(issue_id)
+      get("/issues/#{issue_id}/events/")
     end
 
-    # This endpoint lists an issue’s events.
-    def issues_events
-
-    end
-
-    # This endpoint lists an issue’s hashes, which are the generated checksums used to aggregate individual events.
-    def issues_hashes
-
+    # List an Issue’s Hashes
+    #
+    # @example
+    #   Sentry.issues_hashes('120732258')
+    #
+    # @param issue_id [String] the ID of the issue to retrieve.
+    # @return [Array<Sentry::ObjectifiedHash>]
+    def issue_hashes(issue_id)
+      get("/issues/#{issue_id}/hashes/")
     end
 
     # Removes an individual issue.
-    def remove_issue
-
+    #
+    # @example
+    #   Sentry.remove_issue('120732258')
+    #
+    # @param issue_id [String] the ID of the issue to retrieve.
+    def remove_issue(issue_id)
+      delete("/issues/#{issue_id}/")
     end
 
-    # Return a list of sampled events bound to a project.
+    # Update an individual issue.
     #
     # @example
-    #   Sentry.projects
+    #   Sentry.update_issue('120732258')
+    #   Sentry.update_issue('120732258',{status:'resolved'})
+    #   Sentry.update_issue('120732258',{status:'resolved', assignedTo:'[email protected]'})
     #
-    # @return [Array<Sentry::ObjectifiedHash>]
-    def events
+    # @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.
+    def update_issue(issue_id, options={})
+      put("/issues/#{issue_id}/", body: options)
     end
 
-    # Retrieves the details of the latest sample for an aggregate.
+    # Retrieves the details of the latest event.
     #
     # @example
-    #   Sentry.projects
+    #   Sentry.latest_event('120633628')
     #
-    # @return [Array<Sentry::ObjectifiedHash>]
-    def latest_events
+    # @param issue_id [String] the ID of the issue to retrieve.
+    # @return Sentry::ObjectifiedHash
+    def latest_event(issue_id)
+      get("/issues/#{issue_id}/events/latest/")
     end
 
-    # Retrieves the details of the oldest sample for an aggregate.
+    # Retrieves the details of the oldest event.
     #
     # @example
-    #   Sentry.projects
+    #   Sentry.oldest_event('120633628')
     #
-    # @return [Array<Sentry::ObjectifiedHash>]
-    def oldest_events
+    # @param issue_id [String] the ID of the issue to retrieve.
+    # @return Sentry::ObjectifiedHash
+    def oldest_event(issue_id)
+      get("/issues/#{issue_id}/events/oldest/")
     end
 
   end

lib/sentry/client/organizations.rb

@@ -32,7 +32,7 @@ def organization_projects(organization_slug="")
     #   Sentry.organization('slug')
     #
     # @param organization_slug [String] the slug of the organization the team should be created for.
-    # @return <Sentry::ObjectifiedHash>
+    # @return Sentry::ObjectifiedHash
     def organization(organization_slug="")
       organization_slug = @default_org_slug if organization_slug == ""
       get("/organizations/#{organization_slug}/")
@@ -46,9 +46,10 @@ def organization(organization_slug="")
     #   Sentry.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 options [String] :name an optional new name for the organization.
-    # @param options [String] :slug an optional new slug for the organization. Needs to be available and unique.
-    # @return <Sentry::ObjectifiedHash>
+    # @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
     def update_organization(organization_slug, options={})
       put("/organizations/#{organization_slug}/", body: options)
     end
@@ -60,7 +61,7 @@ def update_organization(organization_slug, options={})
     #   Sentry.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.
+    # @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.

lib/sentry/client/projects.rb

@@ -11,13 +11,14 @@ def projects
       get("/projects/")
     end
 
-    # Retrieve a Project¶.
+    # Retrieve a Project
     #
     # @example
     #   Sentry.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 Sentry::ObjectifiedHash
     def project(project_slug, organization_slug="")
       organization_slug = @default_org_slug if organization_slug == ""
       get("/projects/#{organization_slug}/#{project_slug}/")
@@ -35,6 +36,7 @@ def project(project_slug, organization_slug="")
     # @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 Sentry::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)
@@ -59,7 +61,7 @@ def delete_project(project_slug, organization_slug="")
     #   Sentry.project_stats('slug', {stat:'received', since:'1472158800'})
     #
     # @param project_slug [String] the slug of the project.
-    # @param  [Hash] options A customizable set of options.
+    # @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.
@@ -102,10 +104,10 @@ def client_keys(project_slug, organization_slug="")
     #   Sentry.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.
+    # @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 <Sentry::ObjectifiedHash>
+    # @return Sentry::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)
@@ -131,7 +133,7 @@ def delete_client_key(project_slug, key_id, organization_slug="")
     #
     # @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.
+    # @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<Sentry::ObjectifiedHash>]
@@ -161,7 +163,7 @@ def project_events(project_slug, organization_slug="")
     # @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 <Sentry::ObjectifiedHash>
+    # @return Sentry::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}/")

lib/sentry/objectified_hash.rb

@@ -15,6 +15,7 @@ def initialize(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.

lib/sentry/version.rb

@@ -1,3 +1,3 @@
 module Sentry
-  VERSION = "1.0.0"
+  VERSION = "0.1.0"
 end

sentry.gemspec

@@ -10,13 +10,13 @@ Gem::Specification.new do |spec|
   spec.email = ["[email protected]"]
 
   spec.summary = %q{Ruby client for Sentry API}
-  spec.description = %q{A Ruby wrapper and CLI for the Sentry API}
-  spec.homepage = "https://github.com/thierryxing/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'] = "TODO: Set to 'https://github.com/thierryxing/sentry-api.git'"
+    spec.metadata['allowed_push_host'] = "TODO: Set to 'https://github.com/thierryxing/sentry-ruby-api.git'"
   else
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'yard'
 end