slack-api-wrapper 0.0.5 → 0.0.6

data/lib/slack/web/im.rb

@@ -1,39 +1,88 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
 module Slack
   module Web
+    # Module for the im methods.
+    # Get info on your direct messages.
     module Im
+      # Endpoint scope
       SCOPE = "im"
 
       # Close a direct message channel.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      # @option params [im] 'channel'
+      #   Direct message channel to close.
+      #
+      # @see https://api.slack.com/methods/im.close
       def im_close(params={})
-        throw ArgumentError.new("Required arguments :channel missing") if params['channel'].nil?
+        raise ArgumentError.new("Required arguments 'channel' missing") if params['channel'].nil?
         response = @session.do_get "#{SCOPE}.close", params
         Slack::parse_response(response)
       end
 
       # Fetches history of messages and events from direct message channel.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      # @option params [im] 'channel'
+      #   Direct message channel to fetch history for.
+      # @option params [timestamp] 'latest'
+      #   Latest message timestamp to include in results.
+      # @option params [timestamp] 'oldest'
+      #   Oldest message timestamp to include in results.
+      # @option params [Object] 'inclusive'
+      #   Include messages with latest or oldest timestamp in results.
+      # @option params [Object] 'count'
+      #   Number of messages to return, between 1 and 1000.
+      #
+      # @see https://api.slack.com/methods/im.history
       def im_history(params={})
-        throw ArgumentError.new("Required arguments :channel missing") if params['channel'].nil?
+        raise ArgumentError.new("Required arguments 'channel' missing") if params['channel'].nil?
         response = @session.do_get "#{SCOPE}.history", params
         Slack::parse_response(response)
       end
 
       # Lists direct message channels for the calling user.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      #
+      # @see https://api.slack.com/methods/im.list
       def im_list(params={})
         response = @session.do_get "#{SCOPE}.list", params
         Slack::parse_response(response)
       end
 
       # Sets the read cursor in a direct message channel.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      # @option params [im] 'channel'
+      #   Direct message channel to set reading cursor in.
+      # @option params [timestamp] 'ts'
+      #   Timestamp of the most recently seen message.
+      #
+      # @see https://api.slack.com/methods/im.mark
       def im_mark(params={})
-        throw ArgumentError.new("Required arguments :channel missing") if params['channel'].nil?
-        throw ArgumentError.new("Required arguments :ts missing") if params['ts'].nil?
+        raise ArgumentError.new("Required arguments 'channel' missing") if params['channel'].nil?
+        raise ArgumentError.new("Required arguments 'ts' missing") if params['ts'].nil?
         response = @session.do_get "#{SCOPE}.mark", params
         Slack::parse_response(response)
       end
 
       # Opens a direct message channel.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      # @option params [user] 'user'
+      #   User to open a direct message channel with.
+      #
+      # @see https://api.slack.com/methods/im.open
       def im_open(params={})
-        throw ArgumentError.new("Required arguments :user missing") if params['user'].nil?
+        raise ArgumentError.new("Required arguments 'user' missing") if params['user'].nil?
         response = @session.do_get "#{SCOPE}.open", params
         Slack::parse_response(response)
       end

data/lib/slack/web/search.rb

@@ -1,25 +1,82 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
 module Slack
   module Web
+    # Module for the search methods.
+    # Search your team's files and messages.
     module Search
+      # Endpoint scope
       SCOPE = "search"
 
       # Searches for messages and files matching a query.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      # @option options [Object] 'query'
+      #   Search query. May contains booleans, etc.
+      # @option options [Object] 'sort'
+      #   Return matches sorted by either `score` or `timestamp`.
+      # @option options [Object] 'sort_dir'
+      #   Change sort direction to ascending (`asc`) or descending (`desc`).
+      # @option options [Object] 'highlight'
+      #   Pass a value of `1` to enable query highlight markers.
+      # @option params [Object] 'count'
+      #   Number of items to return per page.
+      # @option params [Object] 'page'
+      #   Page number of results to return.
+      #
+      # @see https://api.slack.com/methods/search.all
       def search_all(params={})
-        throw ArgumentError.new("Required arguments :query missing") if params['query'].nil?
+        raise ArgumentError.new("Required arguments 'query' missing") if params['query'].nil?
         response = @session.do_get "#{SCOPE}.all", params
         Slack::parse_response(response)
       end
 
       # Searches for files matching a query.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      # @option params [Object] 'query'
+      #   Search query. May contains booleans, etc.
+      # @option params [Object] 'sort'
+      #   Return matches sorted by either `score` or `timestamp`.
+      # @option params [Object] 'sort_dir'
+      #   Change sort direction to ascending (`asc`) or descending (`desc`).
+      # @option params [Object] 'highlight'
+      #   Pass a value of `1` to enable query highlight markers.
+      # @option params [Object] 'count'
+      #   Number of items to return per page.
+      # @option params [Object] 'page'
+      #   Page number of results to return.
+      #
+      # @see https://api.slack.com/methods/search.files
       def search_files(params={})
-        throw ArgumentError.new("Required arguments :query missing") if params['query'].nil?
+        raise ArgumentError.new("Required arguments 'query' missing") if params['query'].nil?
         response = @session.do_get "#{SCOPE}.files", params
         Slack::parse_response(response)
       end
 
       # Searches for messages matching a query.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      # @option params [Object] 'query'
+      #   Search query. May contains booleans, etc.
+      # @option params [Object] 'sort'
+      #   Return matches sorted by either `score` or `timestamp`.
+      # @option params [Object] 'sort_dir'
+      #   Change sort direction to ascending (`asc`) or descending (`desc`).
+      # @option params [Object] 'highlight'
+      #   Pass a value of `1` to enable query highlight markers.
+      # @option params [Object] 'count'
+      #   Number of items to return per page.
+      # @option params [Object] 'page'
+      #   Page number of results to return.
+      #
+      # @see https://api.slack.com/methods/search.messages
       def search_messages(params={})
-        throw ArgumentError.new("Required arguments :query missing") if params['query'].nil?
+        raise ArgumentError.new("Required arguments 'query' missing") if params['query'].nil?
         response = @session.do_get "#{SCOPE}.messages", params
         Slack::parse_response(response)
       end

data/lib/slack/web/stars.rb

@@ -1,9 +1,25 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
 module Slack
   module Web
+    # Module for the stars methods.
     module Stars
+      # Endpoint scope
       SCOPE = "stars"
 
       # Lists stars for a user.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      # @option params [user] 'user'
+      #   Show stars by this user. Defaults to the authed user.
+      # @option params [Object] 'count'
+      #   Number of items to return per page.
+      # @option params [Object] 'page'
+      #   Page number of results to return.
+      #
+      # @see https://api.slack.com/methods/stars.list
       def stars_list(params={})
         response = @session.do_get "#{SCOPE}.list", params
         Slack::parse_response(response)

data/lib/slack/web/team.rb

@@ -1,9 +1,23 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
 module Slack
   module Web
+    # Module for the teams methods.
     module Team
+      # Endpoint scope
       SCOPE = "team"
 
       # Gets the access logs for a team.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      # @option params [Object] 'count'
+      #   Number of items to return per page.
+      # @option params [Object] 'page'
+      #   Page number of results to return.
+      #
+      # @see https://api.slack.com/methods/team.access_logs
       def team_access_logs(params={})
         response = @session.do_get "#{SCOPE}.accessLogs", params
         Slack::parse_response(response)

data/lib/slack/web/users.rb

@@ -1,37 +1,74 @@
+# Copyright (c) 2015 Gustavo Bazan
+# MIT License
+
 module Slack
   module Web
+    # Module for the users methods.
+    # Get info on members of your Slack team.
     module Users
+      # Endpoint scope
       SCOPE = "users"
 
       # Gets user presence information.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      # @option options [user] 'user'
+      #   User to get presence info on. Defaults to the authed user.
+      #
+      # @see https://api.slack.com/methods/users.messages
       def users_get_presence(params={})
-        throw ArgumentError.new("Required arguments :user missing") if params['user'].nil?
+        raise ArgumentError.new("Required arguments :user missing") if params['user'].nil?
         response = @session.do_get "#{SCOPE}.getPresence", params
         Slack::parse_response(response)
       end
 
       # Gets information about a user.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      # @option options [user] 'user'
+      #   User to get info on
+      #
+      # @see https://api.slack.com/methods/users.info
       def users_info(params={})
-        throw ArgumentError.new("Required arguments :user missing") if params['user'].nil?
+        raise ArgumentError.new("Required arguments 'user' missing") if params['user'].nil?
         response = @session.do_get "#{SCOPE}.info", params
         Slack::parse_response(response)
       end
 
       # Lists all users in a Slack team.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      #
+      # @see https://api.slack.com/methods/users.list
       def users_list(params={})
         response = @session.do_get "#{SCOPE}.list", params
         Slack::parse_response(response)
       end
 
       # Marks a user as active.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      #
+      # @see https://api.slack.com/methods/users.setActive
       def users_set_active(params={})
         response = @session.do_get "#{SCOPE}.setActive", params
         Slack::parse_response(response)
       end
 
       # Manually sets user presence.
+      #
+      # @param [Hash] params
+      #   API call arguments
+      # @option options [Object] 'presence'
+      #   Either `auto` or `away`
+      #
+      # @see https://api.slack.com/methods/users.setPresence
       def users_set_presence(params={})
-        throw ArgumentError.new("Required arguments :presence missing") if params['presence'].nil?
+        raise ArgumentError.new("Required arguments 'presence' missing") if params['presence'].nil?
         response = @session.do_get "#{SCOPE}.setPresence", params
         Slack::parse_response(response)
       end

data/slack-api-wrapper.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", '~> 0'
   spec.add_development_dependency "rspec", '~> 3.2', '>= 3.2.0'
+  spec.add_development_dependency "yard", '~> 0.8.7', '>= 0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-api-wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Gustavo Bazan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,6 +58,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 description: |2
           A library that provides a plain function-call interface to the
           Slack API web endpoints.
@@ -133,3 +153,4 @@ test_files:
 - spec/slack/oauth2_spec.rb
 - spec/slack_spec.rb
 - spec/spec_helper.rb
+has_rdoc: