boppers 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa2ef8ad5ed1839880731b4cd5aed44c4f510853
-  data.tar.gz: d67c2fd8bb60cd0c71c83ff8959ddf4af16c9abb
+  metadata.gz: 9a7813720dba24c3e0b54524fde1d85e512fded3
+  data.tar.gz: 3a7437f2046dc350bc2e7b5d230adbc792387247
 SHA512:
-  metadata.gz: b18cd291c3c976b780d7404959675300bd144aeec9fc5699555adbb6a92cce74602c99df9bcc695f7451d524765f84b56dcb7d37d0409be1e748ec7bf636c2bc
-  data.tar.gz: c82446d9745f8009ce35b5f99080622e09306a00b7e80e8c10c97c27c6d80054e6ffb6420b3faac98979d63db593957a8723ead8e5ff2a200d1cb2b053a13f15
+  metadata.gz: 5627c872fd83adf4815e8a3e58f80c279cb505ec59b40eaf8cfe2b5864f26d3da2d7653aa5f70286f6c6395b2860635550a0cd88fa435f90313e24dfbe3d0bb0
+  data.tar.gz: 8909d9fe48d32f0b2daf90b5f5ee18b7d691dc4f733248513e098858e2f252e9a828b2aaa35f54b419ea9c526ab23db0d4e4607bcec6e9238fdb597f05f392e1

data/.travis.yml

@@ -1,7 +1,19 @@
 sudo: false
 language: ruby
+cache: bundler
 rvm:
-  - 2.4.2
-before_install: gem install bundler
+- 2.4.2
+before_install:
+  - gem install bundler
+  - bundle install
+before_script:
+- "curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter"
+- chmod +x ./cc-test-reporter
+- "./cc-test-reporter before-build"
+after_script:
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
 notifications:
   email: false
+env:
+  global:
+    secure: eoCW4QzjfgDFpD8ygDYJVpm2gmq4eLvZxsgKarOeGOeh6TYGOuAZrz23TGiXy7XwRPlEd8IJf9DufqegitY8QHmrP09C9mUwlk3LbjwNFvsS0aaMKgxIkaBKzgqtaJSySXaKWzoV8wjCUk3/Ip9CNBLq/vLulOcKF4B1HuxtHUKHGHT/Uj/IJWORukFfhaaTi48d9VcizPWH15yj0w3D507sz/HEm0MaeihYHwLYpScgLlNgzFp8+TlTB1TRjf70rUW2Y480zqdxeDvHaKiQt21wyEHcSOwwNVRLXM8jUHAyAN5bEMGJ4PhVE1ehbYarK28Sm3qdUABZngXP5XVsJPJOmf0QXg/oP0RC/zh7xwYFe3rBGdKBp9Vwc3PopjcVzmxSo0mg0IzObq6Kz0lEuHqbqo3kQBdCmSscLpGjCQA9FGf7ylViaeleLd59YN98jw3Z3/dMwN97VD3IFnqDb/ZSPW8KpQmjOzEXm84NglQfodxCqEejaghKi9dHJToWJrxauyJmO6T1s3ykGowfy/PtfVwbXJaGD9OPjxlnqH8GAHGXFg+6vOsxFBRdtuJ3iX7w9ED80mOxaDFgG9o1dtnL43fudSxywrzGQXpMS97sUBUwHiAsCDcE6D8kxRCp5ki9tzKGnc18xQRlnWpUyuP13b6QzhOVZbuX23IArQc=

data/README.md

@@ -1,15 +1,17 @@
-# Boppers
+![Boppers](https://github.com/fnando/boppers/raw/master/images/logo.png)
 
-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/boppers`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Travis-CI](https://travis-ci.org/fnando/boppers.png)](https://travis-ci.org/fnando/boppers)
+[![GPA](https://codeclimate.com/github/fnando/boppers/badges/gpa.svg)](https://codeclimate.com/github/fnando/boppers)
+[![Test Coverage](https://codeclimate.com/github/fnando/boppers/badges/coverage.svg)](https://codeclimate.com/github/fnando/boppers)
+[![Gem](https://img.shields.io/gem/v/boppers.svg)](https://rubygems.org/gems/boppers)
+[![Gem](https://img.shields.io/gem/dt/boppers.svg)](https://rubygems.org/gems/boppers)
 
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
+# Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'boppers'
+gem "boppers"
 ```
 
 And then execute:
@@ -20,9 +22,279 @@ Or install it yourself as:
 
     $ gem install boppers
 
-## Usage
+# Usage
+
+## Using the CLI
+
+To create a new app, use `boppers app [YOUR APP NAME]`. This will generate a structure so you can just configure your boppers and notifiers.
+
+## Boppers
+
+A bopper is a bot. Basically is a class that responds to `#call`. For instance, a lambda.
+
+```ruby
+Boppers.configure do |config|
+  config.boppers << lambda do
+    Boppers.notify(:clock, title: "Clock", message: "Now is #{Time.now}")
+  end
+end
+```
+
+By default, boppers are executed every 60 seconds. If you create a class, you can define your custom interval by creating a method `#interval`. The following example changes the interval to `15 seconds`.
+
+```ruby
+class Clock
+  def call
+    Boppers.notify(:clock, title: "Clock", message: "Now is #{Time.now}")
+  end
+
+  def interval
+    15
+  end
+end
+
+Boppers.configure do |config|
+  config.boppers << Clock.new
+end
+```
+
+The `Boppers.notify` method expects a event name (the recommended value is the bot's name), a title, message and a hash of options (it's up to the notifier to use the options).
+
+### Distributing boppers
+
+I encourage you to share your boppers. I even added a command to generate a common structure, so you don't have to think about how to organize it. Let's say you want to distribute the clock bopper above.
+
+```
+$ boppers plugin clock
+      create  boppers-clock.gemspec
+      create  gems.rb
+      create  .gitignore
+      create  .rubocop.yml
+      create  .travis.yml
+      create  CODE_OF_CONDUCT.md
+      ...
+```
+
+Now add your bopper code to `lib/boppers/clock.rb`.
+
+```ruby
+# frozen_string_literal: true
+
+require "boppers/clock/version"
+
+module Boppers
+  class Clock
+    def call
+      Boppers.notify(:clock, title: "Clock", message: "Now is #{Time.now}")
+    end
+  end
+end
+```
+
+Change the `boppers-clock.gemspec` file accordingly (add a description, author name and email).
+
+If you're writing tests, use `Boppers::Testing::BopperLinter` to lint your bopper (some basic validations will be made).
+
+```ruby
+# frozen_string_literal: true
+
+require "test_helper"
+
+class BoppersClockTest < Minitest::Test
+  test "lint bopper" do
+    bopper = Boppers::Clock.new
+    Boppers::Testing::BopperLinter.call(bopper)
+  end
+end
+```
+
+Then make a commit and run `rake release` to distribute it (I'm assuming your Rubygems account is already configured).
+
+## Notifiers
+
+A notifier is basically a class that responds to `#call(title, message, options)`. The following example implements a `stderr` notifier.
+
+```ruby
+class Stderr
+  attr_reader :subscribe
+
+  def initialize(subscribe: nil)
+    @subscribe = subscribe
+  end
+
+  def call(title, message, _options)
+    $stderr << "== #{title}\n"
+    $stderr << message.gsub(/^/m, "   ")
+    $stderr << "\n\n"
+  end
+end
+
+Boppers.configure do |config|
+  config.notifiers << Stderr.new
+end
+```
+
+You can specify which messages a notifier will receive by setting `subscribe:`, like the following:
+
+```ruby
+Boppers.configure do |config|
+  config.notifiers << Stderr.new(subscribe: %i[clock])
+end
+```
+
+Now this notifier will only be triggered when `Boppers.notify(:clock, *args)` is called, ignoring other boppers.
+
+### Available notifiers
+
+By default, Boppers comes with the following notifiers.
+
+- [Hipchat](https://www.hipchat.com/sign_in)
+- [Pushover](https://pushover.net)
+- [Sendgrid](https://sendgrid.com)
+- [Slack](https://slack.com)
+- stdout
+- [Telegram](https://telegram.org)
+- [Twitter](https://twitter.com)
+
+#### Hipchat
+
+1. Create a "Send Notification" room API token at `https://[SUBDOMAIN].hipchat.com/rooms`.
+2. The room id is available at the "Summary" section as "API ID".
+
+```ruby
+Boppers.configure do |config|
+  config.notifiers << Boppers::Notifier::Hipchat.new(
+    api_token: "API_TOKEN,
+    room: "ROOM"
+  )
+end
+```
+
+#### Pushover
+
+```ruby
+Boppers.configure do |config|
+  config.notifiers << Boppers::Notifier::Pushover.new(
+    app_token: "APP_TOKEN",
+    user_token: "USER_TOKEN"
+  )
+end
+```
+
+#### Slack
 
-TODO: Write usage instructions here
+1. Create a new bot user at https://my.slack.com/services/new/bot
+2. Set the API token as the `api_token:`.
+3. Set the channel as the `channel:`.
+
+```ruby
+Boppers.configure do |config|
+  config.notifiers << Boppers::Notifier::Slack.new(
+    api_token: "API_TOKEN",
+    channel: "#core"
+  )
+end
+```
+
+#### Sendgrid
+
+```ruby
+Boppers.configure do |config|
+  config.notifiers << Boppers::Notifier::Sendgrid.new(
+    username: "USERNAME",
+    password: "PASSWORD",
+    domain: "DOMAIN",
+    email: "your@email.com"
+  )
+end
+```
+
+#### Stdout
+
+```ruby
+Boppers.configure do |config|
+  config.notifiers << Boppers::Notifier::Stdout.new
+end
+```
+
+#### Telegram
+
+1. [Create a bot](https://core.telegram.org/bots#6-botfather). The returned API token must be defined as `api_token:`.
+2. Send a message to the bot.
+3. Run `ruby setup/telegram.rb` locally to get the channel id. You may need to install the dependencies with `bundle install` before doing it so.
+4. Set the channel  as `channel_id: <channel id>`. Sometimes id can be a negative number and this is important.
+
+```ruby
+Boppers.configure do |config|
+  config.notifiers << Boppers::Notifer::Telegram.new(
+    api_token: "API_TOKEN",
+    channel_id: "CHANNEL_ID"
+  )
+end
+```
+
+#### Twitter
+
+1. Create an user for your bot.
+2. Follow your bot, and make your bot follow you.
+3. Create a new Twitter application under your bot's account at https://apps.twitter.com/app/new
+4. Go to "Keys and Access Tokens" and create a new access token.
+5. Set `consumer_key:`, `consumer_secret:`, `access_token:` and `access_secret:` named arguments, all available under "Keys and Access Token".
+6. Set the user that'll receive the notification as `user: <username>`.
+
+```ruby
+Boppers.configure do |config|
+  config.notifiers << Boppers::Notifer::Twitter.new(
+    consumer_key: "CONSUMER_KEY",
+    consumer_secret: "CONSUMER_SECRET",
+    access_token: "ACCESS_TOKEN",
+    access_secret: "ACCESS_SECRET",
+    user: "someuser"
+  )
+end
+```
+
+### Distributing notifiers
+
+The idea is pretty much the same. Create a new plugin with `boppers plugin [NAME]` and configure it accordingly. There's also a linter for notifiers: `Boppers::Testing::NotifierLinter`.
+
+## Deploying to Heroku
+
+I'm assuming you installed the gem with `gem install boppers` and generated your app.
+
+Add your configuration to `config/boppers.rb`. Also make sure you don't hardcode any sensitive value, like API tokens or passwords. Use [env_vars](https://rubygems.org/gems/env_vars) to manage access to your environment variables.
+
+Now, configure Heroku. Create a new app for this.
+
+```
+heroku create
+```
+
+If you're going to send e-mail notification, you'll need Sendgrid.
+
+```
+heroku addons:create sendgrid:starter
+```
+
+Make a commit and deploy to your Heroku account.
+
+```
+git add .
+git commit -m "Initial commit"
+git push heroku master
+```
+
+Scale up the boppers worker:
+
+```
+heroku ps:scale worker=1
+```
+
+To make your worker run 24/7 (will cost you $7/month):
+
+```
+heroku dyno:type worker=hobby
+```
 
 ## Development
 
@@ -32,7 +304,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/boppers. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/boppers. 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.
 
 ## License
 
@@ -40,4 +312,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Boppers project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/boppers/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Boppers project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fnando/boppers/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -7,6 +7,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
 end
 
 task default: :test

data/boppers.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Nando Vieira"]
   spec.email         = ["fnando.vieira@gmail.com"]
 
-  spec.summary       = "Bots."
+  spec.summary       = "A simple bot framework for individuals."
   spec.description   = spec.summary
   spec.homepage      = "https://rubygems.org/gems/boppers"
   spec.license       = "MIT"
@@ -20,7 +20,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "thor"
+  spec.add_dependency "aitch"
+
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "mail"
+  spec.add_development_dependency "telegram_bot"
+  spec.add_development_dependency "twitter"
 end

data/exe/boppers

@@ -2,3 +2,4 @@
 # frozen_string_literal: true
 
 require "boppers"
+Boppers::CLI.start

data/gems.locked

@@ -1,15 +1,107 @@
 PATH
   remote: .
   specs:
-    boppers (0.0.0)
+    boppers (0.0.1)
+      aitch
+      thor
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    aitch (1.0.2)
+      nokogiri (>= 1.6.0)
+    awesome_print (1.8.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    buftok (0.2.0)
+    byebug (9.1.0)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    equalizer (0.0.11)
+    excon (0.59.0)
+    faraday (0.11.0)
+      multipart-post (>= 1.2, < 3)
+    http (2.2.2)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 1.0.1)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (1.0.3)
+    http_parser.rb (0.6.0)
+    ice_nine (0.11.2)
+    json (2.1.0)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    memoizable (0.4.2)
+      thread_safe (~> 0.3, >= 0.3.1)
+    method_source (0.9.0)
+    mini_mime (0.1.4)
+    mini_portile2 (2.3.0)
     minitest (5.10.3)
     minitest-utils (0.4.0)
       minitest
+    multipart-post (2.0.0)
+    naught (1.1.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    pry (0.11.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.5.0)
+      byebug (~> 9.1)
+      pry (~> 0.10)
+    pry-meta (0.0.10)
+      awesome_print
+      pry
+      pry-byebug
+      pry-remote
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    public_suffix (3.0.0)
     rake (12.2.1)
+    simple_oauth (0.3.1)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    slop (3.6.0)
+    telegram_bot (0.0.7)
+      excon (>= 0.30.0)
+      virtus (>= 1.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    twitter (6.1.0)
+      addressable (~> 2.5)
+      buftok (~> 0.2.0)
+      equalizer (= 0.0.11)
+      faraday (~> 0.11.0)
+      http (~> 2.1)
+      http_parser.rb (~> 0.6.0)
+      memoizable (~> 0.4.2)
+      naught (~> 1.1)
+      simple_oauth (~> 0.3.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.4)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
 
 PLATFORMS
   ruby
@@ -17,8 +109,13 @@ PLATFORMS
 DEPENDENCIES
   boppers!
   bundler
+  mail
   minitest-utils
+  pry-meta
   rake
+  simplecov
+  telegram_bot
+  twitter
 
 BUNDLED WITH
    1.16.0