slappy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8034e5ae2cda470ffff7983b126ca56adfb5efad
+  data.tar.gz: 833b8fe2cba8bc864071119b4ecc670acf625365
+SHA512:
+  metadata.gz: 9e856b1cce7f2bb1a438e727578408b93d9903b79a199295d41e0d9bfd43426a35d4cb7e3774051bc0c6b7c34af76a0e0c5cca0bdd161857b7dfd5029b583ae7
+  data.tar.gz: 5dc257ec761b6f1698c71efd9252f7b0d0aee991f439f2515a7aa7c8bc7babe7c05427762cba7724fdedccecba1bae530ba0c22cb99f7c68240eaacdb90d4d4f

data/.env.sample

@@ -0,0 +1 @@
+SLACK_TOKEN=

data/.gitignore

@@ -0,0 +1,7 @@
+Gemfile.lock
+/.bundle/
+/coverage
+/vendor/bundle
+/tmp
+.env
+/pkg

data/.hound.yml

@@ -0,0 +1,29 @@
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+    - "Gemfile"
+    - "Guardfile"
+    - "slappy.gemspec"
+  DisplayCopNames: true
+
+##################### Style ##################################
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+##################### Metrics ##################################
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 20

data/.rspec

@@ -0,0 +1 @@
+--format documentation --color

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - .hound.yml

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - ruby-head
+before_install: gem install bundler -v "~> 1.10"
+bundler_args: --jobs=2
+cache: bundler
+before_script:
+  - export CODECLIMATE_REPO_TOKEN=46e09f028aadd0d0f7e8aa4d917dc6f053c0a3d9ab0f82aab41f0918acc0384a
+script:
+  - ruby --version
+  - bundle exec rspec
+branches:
+  only:
+    - master

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in slappy.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,37 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec'  do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)/(.+)\.rb$})     { |m| "spec/#{m[1]}/#{m[2]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+
+guard :rubocop, all_on_start: false, cli: ['--format', 'clang', '--display-cop-names'], cmd: 'bundle exec rubocop', notification: true do
+  watch(%r{.+\.rb$})
+  watch(%r{.+\.rake$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 yuemori
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,141 @@
+# Slappy
+
+[![Build Status](https://travis-ci.org/yuemori/slappy.svg?branch=master)](https://travis-ci.org/yuemori/slappy)
+[![Code Climate](https://codeclimate.com/repos/563cbaad1787d72930000582/badges/9753daa4ecd1a303b6ae/gpa.svg)](https://codeclimate.com/repos/563cbaad1787d72930000582/feed)
+[![Test Coverage](https://codeclimate.com/repos/563cbaad1787d72930000582/badges/9753daa4ecd1a303b6ae/coverage.svg)](https://codeclimate.com/repos/563cbaad1787d72930000582/coverage)
+[![Dependency Status](https://gemnasium.com/yuemori/slappy.svg)](https://gemnasium.com/yuemori/slappy)
+
+This gem support to make slack bot with hubot like interface.
+Use the Slack Realtime API(see the [official-documentation](https://api.slack.com/rtm)).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slappy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install slappy
+
+## Usage
+### ENV
+Store configuration value in environment variables. They are easy to change between deploys without changing any code.
+
+```
+SLACK_TOKEN - required (when not configured)
+```
+
+Slack API Token generated in [this page](https://api.slack.com/web).
+
+### Configure
+Configure default settings.
+There configrations effect on send message to slack when use `say` method and should override when option given.
+
+#### Example
+
+```ruby
+require 'slappy'
+
+Slappy.configure do |config|
+  config.username   = 'slappy'
+  config.channel    = '#general'
+  config.icon_emoji = ':slappy:'
+end
+
+slappy = Slappy::Client.new
+slappy.say 'hello!' #=> username: slappy, channel: '#general', icon_emoji: ':slappy:'
+```
+
+#### Configuration Parameters
+
+```
+token      - default: ENV['SLACK_TOKEN']
+botname    - not effect now
+username   - default: 'slappy'
+icon_emoji - default: nil
+channel    - default: '#general'
+icon_url   - default: nil
+```
+
+### Example Code
+
+```ruby
+require 'slappy'
+
+slappy = Slappy::Client.new
+
+# called when start up
+slappy.hello do
+  puts 'successfly connected'
+end
+
+# called when match message
+slappy.hear(/foo/) do
+  puts 'foo'
+end
+
+# called when match message with pattern match
+slappy.hear(/bar (.*)/) do |event|
+  puts event.matches[1] #=> Event#matches return MatchData object
+end
+
+# event object is slack event JSON (convert to [hashie](https://github.com/intridea/hashie))
+slappy.hear(/bar (.*)/) do |event|
+  puts event.channel #=> channel id
+  slappy.say 'slappy!', channel: event.channel #=> to received message channel
+  slappy.say 'slappy!', channel: '#general'
+  slappy.say 'slappy!', username: 'slappy!', icon_emoji: ':slappy:'
+end
+
+slappy.start
+```
+
+## How to run tests
+
+Please create a file named .env on the root of this repository. You can use .env.example file as a template
+
+```
+cp .env.example .env
+```
+
+and edit `.env` file properly.
+
+```
+SLACK_TOKEN=abcd-1234567890-1234567890-1234567890
+```
+
+Then run tests.
+
+```
+bundle install
+bundle exec rspec
+```
+
+## Feature
+
+- [ ] Support private channel
+- [ ] Support Schedule event (cron like)
+- [ ] Generate template settings
+- [ ] CLI commands
+- [ ] Add bot name
+- [ ] client#respond (hubot#respond)
+
+## Contributing
+
+1. Fork it ( http://github.com/aki017/slack-ruby-gem/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`)
+5. Create new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'slappy'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/slappy.rb

@@ -0,0 +1,21 @@
+require 'slappy/client'
+require 'slappy/configuration'
+require 'slappy/version'
+
+module Slappy
+  class << self
+    @configuration = nil
+
+    def configure
+      @configuration = Configuration.new
+
+      yield configuration if block_given?
+
+      configuration
+    end
+
+    def configuration
+      @configuration || configure
+    end
+  end
+end

data/lib/slappy/client.rb

@@ -0,0 +1,56 @@
+require 'slack'
+require 'slappy/event'
+require 'slappy/listener'
+require 'slappy/configuration'
+
+module Slappy
+  class Client
+    def initialize
+      Slack.configure { |slack| slack.token = config.token }
+      @listeners = {}
+    end
+
+    def client
+      @client ||= Slack.realtime
+    end
+
+    def start
+      @listeners.each do |key, array|
+        client.on key do |data|
+          array.each do |listener|
+            event = Event.new(data, listener.pattern) if key == :message
+            listener.call(event)
+          end
+        end
+      end
+      client.start
+    end
+
+    def hello(&block)
+      @listeners[:hello] ||= []
+      @listeners[:hello].push block
+    end
+
+    def hear(regexp, &block)
+      @listeners[:message] ||= []
+      @listeners[:message].push Listener.new(regexp, block)
+    end
+
+    def say(text, options = {})
+      options[:text] = text
+      params = merge_send_params options
+      Slack.chat_postMessage params
+    end
+
+    private
+
+    def config
+      Slappy.configuration
+    end
+
+    def merge_send_params(options)
+      default = config.send_params
+      default.merge options
+    end
+  end
+end

data/lib/slappy/configuration.rb

@@ -0,0 +1,21 @@
+module Slappy
+  class Configuration
+    attr_accessor :username, :botname, :token, :icon_emoji, :channel, :icon_url
+
+    def botname
+      @botname || username
+    end
+
+    def token
+      @token || ENV['SLACK_TOKEN']
+    end
+
+    def username
+      @username || 'slappy'
+    end
+
+    def send_params
+      { username: username, icon_emoji: icon_emoji, channel: channel, icon_url: icon_url }
+    end
+  end
+end

data/lib/slappy/event.rb

@@ -0,0 +1,21 @@
+require 'hashie'
+require 'forwardable'
+
+module Slappy
+  class Event
+    extend Forwardable
+
+    attr_reader :matches
+
+    def_delegators :@data, :method_missing, :respond_to_missing?
+
+    def initialize(data, pattern)
+      @data = Hashie::Mash.new data
+      @matches = text.match pattern
+    end
+
+    def text
+      @data['text'].to_s
+    end
+  end
+end

data/lib/slappy/listener.rb

@@ -0,0 +1,17 @@
+module Slappy
+  class Listener
+    def initialize(regexp, callback)
+      @regexp = regexp
+      @callback = callback
+    end
+
+    def call(event)
+      return unless event.text.match @regexp
+      @callback.call(event)
+    end
+
+    def pattern
+      @regexp
+    end
+  end
+end

data/lib/slappy/version.rb

@@ -0,0 +1,3 @@
+module Slappy
+  VERSION = '0.1.0'
+end

data/slappy.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slappy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slappy"
+  spec.version       = Slappy::VERSION
+  spec.authors       = ["yuemori"]
+  spec.email         = ["yuemori@aiming-inc.com"]
+
+  spec.summary       = %q{Slack bot maker}
+  spec.description   = %q{Simple Slack bot maker. This gem wapper to Slack Realtime API}
+  spec.homepage      = "https://github.com/yuemori/slappy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'slack-api'
+  spec.add_dependency 'hashie'
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "guard-rubocop"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: slappy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yuemori
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slack-api
+  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: hashie
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: guard
+  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: guard-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: rubocop
+  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: guard-rubocop
+  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: dotenv
+  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: codeclimate-test-reporter
+  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: Simple Slack bot maker. This gem wapper to Slack Realtime API
+email:
+- yuemori@aiming-inc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slappy.rb
+- lib/slappy/client.rb
+- lib/slappy/configuration.rb
+- lib/slappy/event.rb
+- lib/slappy/listener.rb
+- lib/slappy/version.rb
+- slappy.gemspec
+homepage: https://github.com/yuemori/slappy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Slack bot maker
+test_files: []