backlog_kit 0.12.1 → 0.13.0

data/lib/backlog_kit/client/space.rb

@@ -1,30 +1,57 @@
 module BacklogKit
   class Client
+
+    # Methods for the Space API
     module Space
+
+      # Get a space
+      #
+      # @return [BacklogKit::Response] The space information
       def get_space
         get('space')
       end
 
+      # Get list of space activities
+      #
+      # @param params [Hash] Request parameters
+      # @return [BacklogKit::Response] List of recent updates in your space
       def get_space_activities(params = {})
         get('space/activities', params)
       end
 
+      # Download a space logo image
+      #
+      # @return [BacklogKit::Response] Binary image data
       def download_space_icon
         get('space/image')
       end
 
+      # Get a space notification
+      #
+      # @return [BacklogKit::Response] The notification information
       def get_space_notification
         get('space/notification')
       end
 
+      # Update a space notification
+      #
+      # @param content [String] Content of the notification
+      # @return [BacklogKit::Response] The notification information
       def update_space_notification(content)
         put('space/notification', content: content)
       end
 
+      # Get a space disk usage
+      #
+      # @return [BacklogKit::Response] The disk usage
       def get_space_disk_usage
         get('space/diskUsage')
       end
 
+      # Upload attachment file for issue or wiki
+      #
+      # @param file_path [String] Path of the file
+      # @return [BacklogKit::Response] The file information
       def upload_attachment(file_path)
         payload = { file: Faraday::UploadIO.new(file_path, 'application/octet-stream') }
         post('space/attachment', payload)

data/lib/backlog_kit/client/star.rb

@@ -1,17 +1,48 @@
 module BacklogKit
   class Client
+
+    # Methods for the Star API
     module Star
+
+      # Add a star to an issue
+      #
+      # @param issue_id [Integer, String] Issue id
+      # @return [BacklogKit::Response] No content response
       def add_issue_star(issue_id)
         post('stars', issue_id: issue_id)
       end
 
+      # Add a star to an issue comment
+      #
+      # @param comment_id [Integer, String] Comment id
+      # @return [BacklogKit::Response] No content response
       def add_issue_comment_star(comment_id)
         post('stars', comment_id: comment_id)
       end
 
+      # Add a star to a wiki page
+      #
+      # @param wiki_id [Integer, String] Wiki page id
+      # @return [BacklogKit::Response] No content response
       def add_wiki_star(wiki_id)
         post('stars', wiki_id: wiki_id)
       end
+
+      # Add a star to a pull request
+      #
+      # @param pull_request_id [Integer, String] Pull request id
+      # @return [BacklogKit::Response] No content response
+      def add_pull_request_star(pull_request_id)
+        post('stars', pull_request_id: pull_request_id)
+      end
+
+      # Add a star to a pull request comment
+      #
+      # @param pull_request_comment_id [Integer, String] Pull request comment id
+      # @return [BacklogKit::Response] No content response
+      def add_pull_request_comment_star(pull_request_comment_id)
+        post('stars', pull_request_comment_id: pull_request_comment_id)
+      end
     end
   end
 end

data/lib/backlog_kit/client/status.rb

@@ -1,6 +1,12 @@
 module BacklogKit
   class Client
+
+    # Methods for the Status API
     module Status
+
+      # Get list of statuses
+      #
+      # @return [BacklogKit::Response] List of statuses
       def get_statuses
         get('statuses')
       end

data/lib/backlog_kit/client/user.rb

@@ -1,54 +1,111 @@
 module BacklogKit
   class Client
+
+    # Methods for the User API
     module User
+
+      # Get list of users
+      #
+      # @return [BacklogKit::Response] List of users
       def get_users
         get('users')
       end
 
+      # Get a user
+      #
+      # @param user_id [Integer, String] User id
+      # @return [BacklogKit::Response] The user information
       def get_user(user_id)
         get("users/#{user_id}")
       end
 
+      # Create a new user
+      #
+      # @param params [Hash] Request parameters
+      # @return [BacklogKit::Response] The user information
       def create_user(params = {})
         post('users', params)
       end
 
+      # Update a user
+      #
+      # @param user_id [Integer, String] User id
+      # @param params [Hash] Request parameters
+      # @return [BacklogKit::Response] The user information
       def update_user(user_id, params = {})
         patch("users/#{user_id}", params)
       end
 
+      # Delete a user
+      #
+      # @param user_id [Integer, String] User id
+      # @return [BacklogKit::Response] The user information
       def delete_user(user_id)
         delete("users/#{user_id}")
       end
 
+      # Get a authentication user
+      #
+      # @return [BacklogKit::Response] The user information
       def get_myself
         get('users/myself')
       end
 
+      # Download a user icon image
+      #
+      # @param user_id [Integer, String] User id
+      # @return [BacklogKit::Response] Binary image data
       def download_user_icon(user_id)
         get("users/#{user_id}/icon")
       end
 
+      # Get list of user activities
+      #
+      # @param user_id [Integer, String] User id
+      # @param params [Hash] Request parameters
+      # @return [BacklogKit::Response] List of user's recent updates
       def get_user_activities(user_id, params = {})
         get("users/#{user_id}/activities", params)
       end
 
+      # Get list of user stars
+      #
+      # @param user_id [Integer, String] User id
+      # @param params [Hash] Request parameters
+      # @return [BacklogKit::Response] List of stars
       def get_user_stars(user_id, params = {})
         get("users/#{user_id}/stars", params)
       end
 
+      # Get number of user stars
+      #
+      # @param user_id [Integer, String] User id
+      # @param params [Hash] Request parameters
+      # @return [BacklogKit::Response] Number of stars
       def get_user_star_count(user_id, params = {})
         get("users/#{user_id}/stars/count", params)
       end
 
+      # Get list of recently viewed issues
+      #
+      # @param params [Hash] Request parameters
+      # @return [BacklogKit::Response] List of recently viewed issues
       def get_recently_viewed_issues(params = {})
         get('users/myself/recentlyViewedIssues', params)
       end
 
+      # Get list of recently viewed projects
+      #
+      # @param params [Hash] Request parameters
+      # @return [BacklogKit::Response] List of recently viewed projects
       def get_recently_viewed_projects(params = {})
         get('users/myself/recentlyViewedProjects', params)
       end
 
+      # Get list of recently viewed wiki pages
+      #
+      # @param params [Hash] Request parameters
+      # @return [BacklogKit::Response] List of recently viewed pages
       def get_recently_viewed_wikis(params = {})
         get('users/myself/recentlyViewedWikis', params)
       end

data/lib/backlog_kit/client/wiki.rb

@@ -1,51 +1,110 @@
 module BacklogKit
   class Client
+
+    # Methods for the Wiki API
     module Wiki
+
+      # Get list of wiki pages
+      #
+      # @param project_id_or_key [Integer, String] Project id or project key
+      # @return [BacklogKit::Response] List of pages
       def get_wikis(project_id_or_key)
         get('wikis', project_id_or_key: project_id_or_key)
       end
 
+      # Get number of wiki pages
+      #
+      # @param project_id_or_key [Integer, String] Project id or project key
+      # @return [BacklogKit::Response] Number of pages
       def get_wiki_count(project_id_or_key)
         get('wikis/count', project_id_or_key: project_id_or_key)
       end
 
+      # Get a wiki page
+      #
+      # @param wiki_id [Integer, String] Wiki page id
+      # @return [BacklogKit::Response] The page information
       def get_wiki(wiki_id)
         get("wikis/#{wiki_id}")
       end
 
+      # Get list of wiki page tags
+      #
+      # @param project_id_or_key [Integer, String] Project id or project key
+      # @return [BacklogKit::Response] List of tags
       def get_wiki_tags(project_id_or_key)
         get('wikis/tags', project_id_or_key: project_id_or_key)
       end
 
+      # Create a new wiki page
+      #
+      # @param name [String] Name of the page
+      # @param content [String] Content of the page
+      # @param project_id [Integer, String] Project id
+      # @param params [Hash] Request parameters
+      # @return [BacklogKit::Response] The page information
       def create_wiki(name, content, project_id, params = {})
         params.merge!(name: name, content: content, project_id: project_id)
         post('wikis', params)
       end
 
+      # Update a wiki page
+      #
+      # @param wiki_id [Integer, String] Wiki page id
+      # @param params [Hash] Request parameters
+      # @return [BacklogKit::Response] The page information
       def update_wiki(wiki_id, params = {})
         patch("wikis/#{wiki_id}", params)
       end
 
+      # Delete a wiki page
+      #
+      # @param wiki_id [Integer, String] Wiki page id
+      # @param params [Hash] Request parameters
+      # @return [BacklogKit::Response] The page information
       def delete_wiki(wiki_id, params = {})
         delete("wikis/#{wiki_id}", params)
       end
 
+      # Get list of shared files on wiki
+      #
+      # @param wiki_id [Integer, String] Wiki page id
+      # @return [BacklogKit::Response] List of files
       def get_wiki_shared_files(wiki_id)
         get("wikis/#{wiki_id}/sharedFiles")
       end
 
+      # Link shared files to wiki
+      #
+      # @param wiki_id [Integer, String] Wiki page id
+      # @param file_ids [Array] List of file ids
+      # @return [BacklogKit::Response] List of files
       def link_wiki_shared_files(wiki_id, file_ids = [])
         post("wikis/#{wiki_id}/sharedFiles", file_id: file_ids)
       end
 
+      # Unlink a shared file on wiki
+      #
+      # @param wiki_id [Integer, String] Wiki page id
+      # @param file_id [Integer, String] Shared file id
+      # @return [BacklogKit::Response] The file information
       def unlink_wiki_shared_file(wiki_id, file_id)
         delete("wikis/#{wiki_id}/sharedFiles/#{file_id}")
       end
 
+      # Get list of wiki histories
+      #
+      # @param wiki_id [Integer, String] Wiki page id
+      # @param params [Hash] Request parameters
+      # @return [BacklogKit::Response] List of histories
       def get_wiki_histories(wiki_id, params = {})
         get("wikis/#{wiki_id}/history", params)
       end
 
+      # Get list of wiki stars
+      #
+      # @param wiki_id [Integer, String] Wiki page id
+      # @return [BacklogKit::Response] List of stars
       def get_wiki_stars(wiki_id)
         get("wikis/#{wiki_id}/stars")
       end

data/lib/backlog_kit/error.rb

@@ -1,5 +1,15 @@
 module BacklogKit
+
+  # Custom error class for rescuing from Backlog errors
+  #
+  # @see http://developer.nulab-inc.com/docs/backlog/error-response
   class Error < StandardError
+
+    # Make a custom error message
+    #
+    # @param response [Hash] Error response
+    # @param index [Integer] Index of the error
+    # @return [String] Error message
     def self.build_error_message(response, index)
       message = "[ERROR #{index}] "
       message += "#{self.name.demodulize} - #{response['message']} (CODE: #{response['code']})"

data/lib/backlog_kit/hash_extensions.rb

@@ -1,6 +1,10 @@
 require 'active_support/core_ext/hash/keys'
 
 class Hash
+
+  # Camelize all keys of the hash
+  #
+  # @return [Hash] The hash with camelized keys
   def camelize_keys!
     deep_transform_keys! do |key|
       key.to_s

data/lib/backlog_kit/version.rb

@@ -1,3 +1,3 @@
 module BacklogKit
-  VERSION = '0.12.1'.freeze
+  VERSION = '0.13.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backlog_kit
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.13.0
 platform: ruby
 authors:
 - emsk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-17 00:00:00.000000000 Z
+date: 2015-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 description: Client library for the Nulab's Backlog API version 2 written in Ruby.
 email:
 - emsk1987@gmail.com
@@ -175,6 +203,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -218,7 +247,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -231,3 +260,4 @@ signing_key:
 specification_version: 4
 summary: Wrapper for the Backlog API v2.
 test_files: []
+has_rdoc: