tarumi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1dc45129272a733c25133c4f0735da412585237
+  data.tar.gz: 8960015ed1b1ec4234dd8c11cee4996e17393f08
+SHA512:
+  metadata.gz: 9d8dea22f78f6411cff9ebe642bb8e7d24df26358b013334e419054f98ab4a304b1c9e9d9449fdc7b279e65eabe44730efb562b85cce1baf9a896e5643fa6c1c
+  data.tar.gz: abed9a0ea945f41be881160f847a2a26629499cfe4e9d663e634715164b2131d1ec9dbafb52cb78fc6404c105e6e8c9ed4b9c44b2c20dda70889683e2b5d05b2

data/.gitignore

@@ -0,0 +1,32 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# OS specific files
+.DS_Store
+.netrc
+
+*.diff
+*.err
+*.orig
+*.log
+*.rej
+*.swo
+*.swp
+*.zip
+*.vi
+*~

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <year> <copyright holders>
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Abraham Kuri
+
+MIT License
+
+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,88 @@
+# Tarumi
+===
+
+Tarumi is a super simple library written in Ruby to interact with [Slack](https://slack.com/) webhooks. It was written by [Abraham Kuri](https://github.com/kurenn) from [Icalia Labs](https://github.com/IcaliaLabs).
+
+## Table of contents
+- [Configure Slack](#configure-slack)
+- [Installation & Usage](#installation-&-usage)
+- [Contributing](#contributing)
+- [Heroes](#heroes)
+- [License](#license)
+
+## Configure Slack
+
+Before you can start integrating the gem, you need to first add a webhook to which the bot wil ping and then send out the message, so let's do that:
+
+1. Open [https://api.slack.com/](https://api.slack.com/) and sign in if you haven't
+2. Go to the [Integrations](https://icalialabs.slack.com/services/new) section
+3. Then look for the [Incoming WebHooks](https://icalialabs.slack.com/services/new/incoming-webhook) integration
+4. Select the channel you wish to hook the service
+5. You'll be redirected to a page with some steps to test the webhook, just take note of the token on the left.
+
+You are now ready to go!
+
+
+## Installation & Usage
+
+You can install and use Tarumi as a stand-alone library, to install it just run:
+
+```console
+$ gem install tarumi
+```
+
+If you are using Rails, just add it to your Gemfile:
+
+```ruby
+gem "tarumi"
+```
+
+And then run the `bundle` command to install it:
+
+```console
+$ bundle
+```
+
+A simple example on how to use it is presented below:
+
+```ruby
+require 'tarumi'
+
+slackBot = Tarumi::Bot.new("yourteam", "yourtoken", hash_of_options)
+slackBot.ping "A text to post"
+```
+
+The example above will post a message to the `#general` channel, but you can easily customize it with the hash of options when initializing the bot:
+
+```ruby
+options = {
+	username: "usernametopost",
+	channel: "#anotherchannel",
+	hook_name: "webhookname"
+}
+```
+That should be it for you to easily configure the bot and start sending messages.
+
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/tarumi/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
+
+
+## Heroes
+
+**Abraham Kuri**
+
++ [http://twitter.com/kurenn](http://twitter.com/kurenn)
++ [http://github.com/kurenn](http://github.com/kurenn)
++ [http://klout.com/#/kurenn](http://klout.com/#/kurenn)
+
+
+## Copyright and license
+
+Code and documentation copyright 2013-2014 Icalia Labs. Code released under [the MIT license](LICENSE).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/tarumi/bot.rb

@@ -0,0 +1,40 @@
+require 'httparty'
+
+module Tarumi
+  class Bot
+    include HTTParty
+
+    attr_reader :options, :username, :channel,
+                :hook_name
+
+    # Add the default format to be json on each request
+    format :json
+
+    # We don't want Rails to be nasty with the parameters we send
+    disable_rails_query_string_format if defined?(Rails)
+
+    def initialize(team, token, options = {})
+      self.class.base_uri("https://#{team}.slack.com") 
+      self.class.default_params(token: token) #we sent this token on each request
+
+      @username = options[:username] || "webhookbot"
+      @channel = options[:channel] || "#general"
+      @hook_name = options[:hook_name] || "incoming-webhook"
+
+      raise ArgumentError, 'You need to specify a team' if team.blank?
+      raise ArgumentError, 'You need to specify the token, to get one go to https://yourteamname.slack.com/services/new' if token.blank?
+    end
+
+    def ping(text, options = {})
+      payload = { text: text, channel: @channel, username: @username }.merge(options)
+      body = { body: "payload=#{payload.to_json}"}
+
+      response = self.class.post("/services/hooks/#{@hook_name}", body) 
+
+      raise ArgumentError, 'You need to specify a text' if text.blank?
+
+      "#{response.body} - #{response.code}"
+    end
+
+  end
+end

data/lib/tarumi/version.rb

@@ -0,0 +1,3 @@
+module Tarumi
+  VERSION = "0.0.1"
+end

data/lib/tarumi.rb

@@ -0,0 +1,8 @@
+require "tarumi/version"
+require 'active_support/dependencies'
+
+module Tarumi
+  extend ActiveSupport::Autoload
+
+  autoload :Bot
+end

data/tarumi.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tarumi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tarumi"
+  spec.version       = Tarumi::VERSION
+  spec.authors       = ["Abraham Kuri"]
+  spec.email         = ["kurenn@icalialabs.com"]
+  spec.summary       = %q{A super simple library to interact with Slack webhooks}
+  spec.description   = %q{A super simple library to interact with Slack webhooks}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "httparty"
+  spec.add_dependency "activesupport"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: tarumi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Abraham Kuri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: httparty
+  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: activesupport
+  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'
+description: A super simple library to interact with Slack webhooks
+email:
+- kurenn@icalialabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tarumi.rb
+- lib/tarumi/bot.rb
+- lib/tarumi/version.rb
+- tarumi.gemspec
+homepage: ''
+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.2.1
+signing_key: 
+specification_version: 4
+summary: A super simple library to interact with Slack webhooks
+test_files: []
+has_rdoc: