slack-ruby-client 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bddd0a87e5708039190f6426332ea467d989f691
-  data.tar.gz: 20b28016a329478c0dfcf1ebfb270c33e7c9e5b7
+  metadata.gz: 83beab009684f102b815d58a123f2a7dc50975fd
+  data.tar.gz: 151c2fc2b883a65ff6eaced3054b2db8e607b599
 SHA512:
-  metadata.gz: 617b369a14e5c896000962d3c917ba05d07af9cffdb6c08891ceb389161ff0f5e2de568601e0460ac99bd1fc1cdcaf7ed91cb6ea647797e00600ef9fad348c7b
-  data.tar.gz: 84bfc168239d0e7699b9f2192a5a1dde2c272a32910cc6867ed8ecb71a0ec83e9d7216a7cef3e3c7f66e67b79b8f5a5e9142f6c1b7a359e205be6e65575d088c
+  metadata.gz: 0c584024b15b6f07310702399dea5a0ae82c703821d5a33a447e749ce677bedc0b38d2e01d89ebb983fe14f4819fa2a295ec43ca94372f7b142686255ba660d3
+  data.tar.gz: c797d350c47ed7acf6eb942a723cb57ccb79897360677aa12bdece2fbce3298c6bec06139a8f0e3c27602e62e4bcfb2dac4b9f63e81904ba938b191d0cbe8789

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-12-06 15:38:34 -0500 using RuboCop version 0.35.0.
+# on 2016-01-08 09:24:26 -0500 using RuboCop version 0.35.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -13,6 +13,13 @@ Lint/HandleExceptions:
     - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
     - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
 
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreEmptyBlocks.
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'lib/slack/messages/formatting.rb'
+
 # Offense count: 2
 Metrics/AbcSize:
   Max: 20
@@ -22,22 +29,17 @@ Metrics/AbcSize:
 Metrics/ClassLength:
   Max: 112
 
-# Offense count: 324
+# Offense count: 380
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 288
 
-# Offense count: 3
+# Offense count: 4
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 15
 
-# Offense count: 1
-Style/AsciiComments:
-  Exclude:
-    - 'lib/slack/web/api/endpoints/team.rb'
-
-# Offense count: 41
+# Offense count: 44
 # Configuration parameters: Exclude.
 Style/Documentation:
   Enabled: false
@@ -48,12 +50,12 @@ Style/FileName:
   Exclude:
     - 'lib/slack-ruby-client.rb'
 
-# Offense count: 74
+# Offense count: 85
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Enabled: false
 
-# Offense count: 11
+# Offense count: 15
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/MethodName:
   Enabled: false
@@ -64,3 +66,9 @@ Style/ModuleFunction:
     - 'lib/slack/config.rb'
     - 'lib/slack/real_time/config.rb'
     - 'lib/slack/web/config.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'lib/slack/messages/formatting.rb'

data/CHANGELOG.md

@@ -1,7 +1,12 @@
+### 0.5.2 (1/8/2015)
+
+* [#41](https://github.com/dblock/slack-ruby-client/issues/41): Added `Slack::Messages::Formatting#unescape` - [@dblock](https://github.com/dblock).
+* Added `files_comments` to Web API - [@dblock](https://github.com/dblock).
+
 ### 0.5.1 (1/4/2016)
 
-* Added `dnd_teamInfo`, `dnd_setSnooze`, `dnd_info`, `dnd_endSnooze` and `dnd_endDnd` - [@dblock](https://github.com/dblock).
-* The `files_upload` method now requires both `file` and `filename` - [@dblock](https://github.com/dblock).
+* Added `dnd_teamInfo`, `dnd_setSnooze`, `dnd_info`, `dnd_endSnooze` and `dnd_endDnd` to Web API - [@dblock](https://github.com/dblock).
+* The `files_upload` method now requires both `file` and `filename` to Web API - [@dblock](https://github.com/dblock).
 
 ### 0.5.0 (12/7/2015)
 

data/README.md

@@ -18,7 +18,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web) and [RealTime Messa
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client, 0.5.1. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 0.5.2. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -250,7 +250,7 @@ EM.run do
 end
 ```
 
-See a fullly working example in [examples/hi_real_time_async](examples/hi_real_time_async/hi.rb).
+See a fully working example in [examples/hi_real_time_async](examples/hi_real_time_async/hi.rb).
 
 ##### Faye::Websocket with Eventmachine
 
@@ -268,6 +268,33 @@ Add the following to your Gemfile.
 gem 'celluloid-io'
 ```
 
+### Message Parsing
+
+All text in Slack uses the same [system of escaping](https://api.slack.com/docs/formatting): chat messages, direct messages, file comments, etc. Use [Slack::Messages::Formatting](lib/slack/messages/formatting.rb) to unescape incoming messages. This comes handy, for example, you want to treat all input to a real time bot as plain text.
+
+```ruby
+Slack::Messages::Formatting.unescape('Hello & <world>'))
+  # => 'Hello & <world>'
+Slack::Messages::Formatting.unescape('Hey <@U024BE7LH|bob>, did you see my file?'))
+  # => 'Hey @bob, did you see my file?'
+Slack::Messages::Formatting.unescape('Hey <@U02BEFY4U>'))
+  # => 'Hey @U02BEFY4U'
+Slack::Messages::Formatting.unescape('This message contains a URL <http://foo.com/>'))
+  # => 'This message contains a URL http://foo.com/'
+Slack::Messages::Formatting.unescape('So does this one: <http://www.foo.com|www.foo.com>'))
+  # => 'So does this one: www.foo.com'
+Slack::Messages::Formatting.unescape('<mailto:bob@example.com|Bob>'))
+  # => 'Bob'
+Slack::Messages::Formatting.unescape('Hello <@U123|bob>, say hi to <!everyone> in <#C1234|general>'))
+  # => 'Hello @bob, say hi to @everyone in #general'
+Slack::Messages::Formatting.unescape('Hello <@U123|bob> &gt; file.txt'))
+  # => 'Hello @bob > file.txt'
+Slack::Messages::Formatting.unescape('“hello”'))
+  # => '"hello"'
+Slack::Messages::Formatting.unescape('‘hello’'))
+  # => "'hello'"
+```
+
 ### Command-Line Client
 
 The slack command-line client returns JSON data from the Slack API.

data/bin/commands/files.rb

@@ -2,6 +2,17 @@
 
 desc 'Get info on files uploaded to Slack, upload new files to Slack.'
 command 'files' do |g|
+  g.desc 'Edit an existing comment on a file. Only the user who created a comment may make edits. Teams may configure a limited time window during which file comment edits are allowed.'
+  g.long_desc %( Edit an existing comment on a file. Only the user who created a comment may make edits. Teams may configure a limited time window during which file comment edits are allowed. )
+  g.command 'comments' do |c|
+    c.flag 'file', desc: 'File containing the comment to edit.'
+    c.flag 'id', desc: 'The comment to edit.'
+    c.flag 'comment', desc: 'Text of the comment to edit.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_comments(options))
+    end
+  end
+
   g.desc 'This method deletes a file from your team.'
   g.long_desc %( This method deletes a file from your team. )
   g.command 'delete' do |c|

data/lib/slack-ruby-client.rb

@@ -1,6 +1,9 @@
 require 'slack/version'
 require 'slack/config'
 
+# Messages
+require 'slack/messages/formatting'
+
 # Web API
 require 'faraday'
 require 'faraday_middleware'

data/lib/slack/messages/formatting.rb

@@ -0,0 +1,29 @@
+module Slack
+  module Messages
+    module Formatting
+      class << self
+        #
+        # Unescape a message.
+        # @see https://api.slack.com/docs/formatting
+        #
+        def unescape(message)
+          CGI.unescapeHTML(message.gsub(/[“”]/, '"')
+            .gsub(/[‘’]/, "'")
+            .gsub(/<(?<sign>[?@#!]?)(?<dt>.*?)>/) do |match|
+              sign = $~[:sign]
+              dt = $~[:dt]
+              rhs = dt.split('|', 2).last
+              case sign
+              when '@', '!'
+                "@#{rhs}"
+              when '#'
+                "##{rhs}"
+              else
+                rhs
+              end
+            end)
+        end
+      end
+    end
+  end
+end

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.5.1'
+  VERSION = '0.5.2'
 end

data/lib/slack/web/api/endpoints/files.rb

@@ -5,6 +5,24 @@ module Slack
     module Api
       module Endpoints
         module Files
+          #
+          # Edit an existing comment on a file. Only the user who created a comment may make edits. Teams may configure a limited time window during which file comment edits are allowed.
+          #
+          # @option options [file] :file
+          #   File containing the comment to edit.
+          # @option options [Object] :id
+          #   The comment to edit.
+          # @option options [Object] :comment
+          #   Text of the comment to edit.
+          # @see https://api.slack.com/methods/files.comments
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files.comments.json
+          def files_comments(options = {})
+            throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
+            throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+            throw ArgumentError.new('Required arguments :comment missing') if options[:comment].nil?
+            post('files.comments', options)
+          end
+
           #
           # This method deletes a file from your team.
           #

data/spec/slack/messages/formatting_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Slack::Messages::Formatting do
+  subject do
+    Slack::Messages::Formatting
+  end
+  context '#unescape' do
+    it 'plain text' do
+      expect(subject.unescape('plain text')).to eq 'plain text'
+    end
+    it 'decodes an HTML-encoded message' do
+      expect(subject.unescape('Hello &amp; &lt;world&gt;')).to eq 'Hello & <world>'
+    end
+    it 'unescapes a user reference' do
+      expect(subject.unescape('Hey <@U024BE7LH|bob>, did you see my file?')).to eq 'Hey @bob, did you see my file?'
+    end
+    it 'unescapes a user reference without a name' do
+      expect(subject.unescape('<@U02BEFY4U> ^^^')).to eq '@U02BEFY4U ^^^'
+    end
+    it 'unescapes a URL without text' do
+      expect(subject.unescape('This message contains a URL <http://foo.com/>')).to eq 'This message contains a URL http://foo.com/'
+    end
+    it 'unescapes a URL with text' do
+      expect(subject.unescape('So does this one: <http://www.foo.com|www.foo.com>')).to eq 'So does this one: www.foo.com'
+    end
+    it 'removes mailto' do
+      expect(subject.unescape('<mailto:bob@example.com|Bob>')).to eq 'Bob'
+    end
+    it 'unlinkifies references' do
+      expect(subject.unescape('Hello <@U123|bob>, say hi to <!everyone> in <#C1234|general>')).to eq 'Hello @bob, say hi to @everyone in #general'
+    end
+    it 'can handle a lone &gt;' do
+      expect(subject.unescape('Hello <@U123|bob> &gt; file.txt')).to eq 'Hello @bob > file.txt'
+    end
+    it 'unescapes a double smart quote' do
+      expect(subject.unescape('“hello”')).to eq '"hello"'
+    end
+    it 'unescapes a single smart quote' do
+      expect(subject.unescape('‘hello’')).to eq "'hello'"
+    end
+  end
+end

metadata

@@ -1,167 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-04 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: websocket-driver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: gli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -185,12 +185,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".gitmodules"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
+- .gitignore
+- .gitmodules
+- .rspec
+- .rubocop.yml
+- .rubocop_todo.yml
+- .travis.yml
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -236,6 +236,7 @@ files:
 - lib/slack-ruby-client.rb
 - lib/slack.rb
 - lib/slack/config.rb
+- lib/slack/messages/formatting.rb
 - lib/slack/real_time/api/message.rb
 - lib/slack/real_time/api/message_id.rb
 - lib/slack/real_time/api/ping.rb
@@ -294,6 +295,7 @@ files:
 - spec/fixtures/slack/web/users_list.yml
 - spec/integration/integration_spec.rb
 - spec/slack/config_spec.rb
+- spec/slack/messages/formatting_spec.rb
 - spec/slack/real_time/api/message_spec.rb
 - spec/slack/real_time/api/ping_spec.rb
 - spec/slack/real_time/api/typing_spec.rb
@@ -322,17 +324,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Slack Web and RealTime API client.
@@ -344,6 +346,7 @@ test_files:
 - spec/fixtures/slack/web/users_list.yml
 - spec/integration/integration_spec.rb
 - spec/slack/config_spec.rb
+- spec/slack/messages/formatting_spec.rb
 - spec/slack/real_time/api/message_spec.rb
 - spec/slack/real_time/api/ping_spec.rb
 - spec/slack/real_time/api/typing_spec.rb