Code Monkey home page Code Monkey logo

bbscan's Introduction

BBScan

This is a utility demonstrating the use of the ContexIO API to examine emails in an inbox and parse out friend notifications from a hypothetical BitBuddy.com coder friends website. Emails of note have a subject line of New Friends On BitBiddy.com! (sic).

Inside those messages there are HTML-formatted sections enumerating the friends that have been added.

This gem installs a command-line tool called bbscan that will check the mailbox and print out a list of friends.

Installation

Add this line to your application's Gemfile:

gem 'bbscan'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bbscan

Usage

Before you begin, you need to create add the following variables to your environment: CIO_KEY, CIO_SECRETE, BBS_MAIL. The first two are self-explanatory; the third is the email address that BitBuddy.com is delivering the friend notifications to.

The easiest way to do this is to add a .env file to your project/home directory with the following:

CIO_KEY=<YOUR_CONTEXTIO_KEY>
CIO_SECRET=<YOUR_CONTEXTIO_SECRET>
BBS_MAIL=<YOUR_EMAIL_ACCT>

Then you can use the bbscan command like so:

$ bbscan
  +---------------+-------------------------------------+
  | name          | profile                             |
  +---------------+-------------------------------------+
  | Terrance Lee  | http://bitbuddy.com/users/hone02    |
  | Josh Williams | http://bitbuddy.com/users/jw        |
  | Ben Hamill    | http://bitbuddy.com/users/benhamill |
  | Brad Fults    | http://bitbuddy.com/users/h3h       |
  +---------------+-------------------------------------+

$

The application will cache results between runs so that you don't keep seeing the same friends in the list over and over. If you want to bust the cache, delete the file ~/.bbscan_cache.

TODO

  1. Tests. Tests. More tests.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

bbscan's People

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.