slack-rtm-bot-helper 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5db6fe4f1bcffd16097cc3efd9ae4c3f476e2f01
-  data.tar.gz: 5d8062090bd254d1befe5c10c4becbdca356ca3d
+  metadata.gz: 9b58e4b64f1453466b18c928a2b05ec29c87505e
+  data.tar.gz: a81c51c70b783ba18847e334cb6a818ed7207060
 SHA512:
-  metadata.gz: 96fd89d7df065454df2a1831e6495363dba20f2abb43d9f23285f68beb2860e52b5339e328d286a27e91875c1f9401ba788adf5bb94130d3c9c52ffd6dc7da11
-  data.tar.gz: 3092b411bf904edba57174093c9ffa1f50352cf690eab297673b242761ad5af53907852a24a569226468f039e3338968778b76579e5726265b8655a7d3bb5628
+  metadata.gz: 725d1aabb7671925b3f975cf77ced749b9e623a9d579802f99b8cf05deb7c359f29cd7d33d149fb25e069cd5b26cb202f20e0931204e68fc2125e18ebe4a83b4
+  data.tar.gz: 9cdcdbad412fbf9725281abd38de40a4392748a408ae05392181f3b915d5b6124706022172159016a1c1147eb692c996ca428395816bcd9016889d2f8da9a5ce

data/README.md

@@ -1,8 +1,6 @@
 # Slack::Rtm::Bot::Helper
 
-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/slack/rtm/bot/helper`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-slack-rtm-bot-helper supports development slack real time messaging bot.
+This gem help develop slack bot using Real Time Message API.
 
 ## Installation
 
@@ -25,26 +23,14 @@ Or install it yourself as:
 ```rb
 require 'slack-rtm-bot-helper'
 
-# channelはなかったら送信してきたchannelに返す。
-Slack::Rtm::Bot::Helper.run(token='', channel='') do
-  # messageを作るロジック
+Slack::Rtm::Bot::Helper.run(token: '<your slack token>', channel: '<channel name>', name: '<bot name>') do
+  # input your logic that create reply message.
+  # return string
 end
 ```
-
-## Development
-
-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.
-
-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).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/slack-rtm-bot-helper. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+- token and block is required.  
+- if set channel , send message only specified channel.  
+- if set name, only reaction message starts `@botname`.  
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Slack::Rtm::Bot::Helper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/slack-rtm-bot-helper/blob/master/CODE_OF_CONDUCT.md).

data/lib/slack-rtm-bot-helper/helper.rb

@@ -3,28 +3,30 @@ module Slack
     module Bot
       class Helper
         class NotEnoughArgumentsError < StandardError; end
-        SLACK_URL = 'https://slack.com'
-        RTM_PATH  = '/api/rtm.start'
+        SLACK_URL   = 'https://slack.com'
+        RTM_PATH    = '/api/rtm.start'
+        USERS_PATH  = '/api/users.list'
 
-        attr_accessor :channel, :message_block, :id, :wss
+        attr_accessor :channel, :message_block, :id, :me, :wss
 
-        def initialize(token, channel, message_block)
+        def initialize(token, channel, name, message_block)
           @token         = token
           @channel       = channel
           @message_block = message_block
+          @me            = me_id(token, name) unless name.nil?
 
           @id  = 1
           @wss = nil
         end
 
-        def self.run(token=nil, channel=nil, &message_block)
+        def self.run(token:nil, channel:nil, name: nil, &message_block)
           raise NotEnoughArgumentsError if token.nil? || message_block.nil?
 
-          s = new(token, channel, message_block)
+          s = new(token, channel, name, message_block)
           s.connect
 
           loop do
-            sleep 5
+            sleep 2
             unless s.wss.open?
               s.connect
             end
@@ -46,27 +48,48 @@ module Slack
           @wss.on :message, &(base_block(self))
         end
 
+        def to_me?(text)
+          text.match?(/^<@#{@me}/)
+        end
+
         private
-          def base_block(helper)
-            Proc.new do |msg|
-              data = ::JSON.parse(msg.data)
-              close if data.empty?
-
-              msg = helper.message_block.call(data) if !data['text'].empty?
-
-              if !msg.nil? && !msg.empty?
-                target_ch = helper.channel || data['channel']
-                msg_json = {
-                   id:      helper.id,
-                   type:    'message',
-                   channel: target_ch,
-                   text:    msg
-                }.to_json
-
-                send(msg_json) && helper.id += 1
-              end
+
+        def me_id(token, name)
+          conn = ::Faraday.new(SLACK_URL) do |faraday|
+            faraday.request  :url_encoded
+            faraday.adapter  ::Faraday.default_adapter
+          end
+
+          res = conn.post USERS_PATH, token: @token
+          (::JSON.parse(res.body)['members'].select { |m| m['name'] == name }.first)&.fetch('id')
+        end
+
+        def base_block(helper)
+          Proc.new do |msg|
+            data = ::JSON.parse(msg.data)
+            close if data.empty?
+
+            msg = if !data['text'].empty?
+                    if helper.me.nil?
+                      helper.message_block.call(data) 
+                    else
+                      helper.message_block.call(data) if helper.to_me?(data['text'])
+                    end
+                  end
+
+            if !(msg.nil? || msg.empty?)
+              target_ch = helper.channel || data['channel']
+              msg_json = {
+                 id:      helper.id,
+                 type:    'message',
+                 channel: target_ch,
+                 text:    msg.to_s
+              }.to_json
+
+              send(msg_json) && helper.id += 1
             end
           end
+        end
       end
     end
   end

data/lib/slack-rtm-bot-helper/version.rb

@@ -2,7 +2,7 @@ module Slack
   module Rtm
     module Bot
       class Helper
-        VERSION = "0.1.3"
+        VERSION = "1.0.0"
       end
     end
   end

data/slack-rtm-bot-helper.gemspec

@@ -35,4 +35,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-rtm-bot-helper
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 1.0.0
 platform: ruby
 authors:
 - littlekbt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2017-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 description: 
 email:
 - kr.kubota.11@gmail.com
@@ -89,7 +103,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at kr.kubota.11@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/