slack-ruby 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5a0fb441d7414a2a0da1a58f4e6931b57b421b8
-  data.tar.gz: 859b4e78624453ea375dc41887bbe60b72b83b87
+  metadata.gz: 3f074cb6479f2a0dd14697315aa72a73e0251cc3
+  data.tar.gz: 7000599487522caf432ab6fe86268050a330b79c
 SHA512:
-  metadata.gz: 3ca8aa7091c3c760b4b787aad9ab659131f55f8aaccd18465f431cbf56bc5028750f850b393fb27d7e1537e816ff30b13f12d043ab5de227a22f9628b2f364ec
-  data.tar.gz: 2a8870d09739ed85b71f22a26faead18883b08fe252864a8953680a1059aff8b8722eb3323b15ea643a45009b138320d88553e65a4e0229d9dbe9d0a6fd7655e
+  metadata.gz: eb992a603b00664ee58f4f2a312f5957021b67f42b44f89ea5330fd11131e8a9bf78957104dba109d2804ef08a5e281fbfdfc0155737377ea51c78bf1032796e
+  data.tar.gz: 20390238b3894f53fedca4941e595aa4fd365d1d9dbb3610264f1bbfb0391c8f4a94c3f42a5c80542186c94186ec766181406ea9f1b0c6cbe6f2724a64069ff9

data/README.md

@@ -1,6 +1,6 @@
 # Slack::Ruby
 
-TODO: Write a gem description
+A Ruby interface to [Slack API](https://api.slack.com/).
 
 ## Installation
 
@@ -20,11 +20,41 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### How to use RPC-Style Web API
+
+```ruby
+require "slack"
+
+# create RPC client object with OAuth token
+client = Slack::RPC::Client.new("xxxx-xxxxxxxxx-xxxx")
+
+# execute RPC command and retrieve response
+client.channels.archive(:channel => "C1234567890") do |response|
+  # your own code
+end
+
+# or you can get response as returned object
+response = client.channels.unarchive(:channel => "C1234567890")
+# your own code
+```
+
+#### RPC command
+
+see [Slack Web API Document](https://api.slack.com/web)
+
+#### Response object
+
+- ```Slack::RPC::Response.status``` is HTTP status code as integer
+- ```Slack::RPC::Response.headers``` is HTTP response header as Hash object
+- ```Slack::RPC::Response.body``` is HTTP response body as Hash object
+
+### How to use Real Time Messaging API
+
+TODO
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/slack-ruby/fork )
+1. Fork it ( https://github.com/morou/slack-ruby/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/slack/rpc/command.rb

@@ -18,8 +18,8 @@ module Slack
 			# ### Slack::RPC::Command.invoke_command
 			# Invokes Slack RPC-Style command
 			#
-			def call(sub_command, args, &block)
-				@connection.call(@command, sub_command, args, &block)
+			def call(sub_command, params, &block)
+				@connection.call(@command, sub_command, params, &block)
 			end
 			
 			# ### Slack::RPC::Command.respond_to?(name)
@@ -33,8 +33,9 @@ module Slack
 			# Invoked by Ruby when obj is sent a message it cannot handle.
 			#
 			def method_missing(name, *args, &block)
-				if @sub_commands.include?(name.to_s) && args.length == 1 && args[0].class == Hash then
-					call(name.to_s, args[0], &block)
+				if @sub_commands.include?(name.to_s) then
+					params = (args.length == 1 && args[0].class == Hash) ? args[0] : {}
+					call(name.to_s, params, &block)
 				else
 					super
 				end

data/lib/slack/rpc/connection.rb

@@ -30,11 +30,11 @@ module Slack
 				@token = token
 			end
 
-			# ### Slack::RPC::Connection.call(command, sub_commnad, args, &block)
+			# ### Slack::RPC::Connection.call(command, sub_commnad, params, &block)
 			# Call Slack RPC-Style command
 			#
-			def call(command, sub_command, args, &block)
-				faraday_response = connection.get("#{command}.#{sub_command}", args.clone.merge({:token => @token}))
+			def call(command, sub_command, params, &block)
+				faraday_response = connection.get("#{command}.#{sub_command}", params.clone.merge({:token => @token}))
 				response = Response.new(faraday_response)
 				if block then
 					yield response

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - morou