hexabat 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rbx
+
+examples/

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@hexabat --create

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx-19mode
+    - rvm: jruby-19mode
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - ruby-head
+  - rbx-19mode
+  - jruby-19mode

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 path11
+
+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,119 @@
+# Hexabat [![Build Status](https://secure.travis-ci.org/jacegu/hexabat.png?branch=master)](http://travis-ci.org/jacegu/hexabat)  [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/jacegu/hexabat)
+
+**Hexabat is a Github issues importer tool for Ruby.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hexabat'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hexabat
+
+
+## Overview
+
+The
+[Github issues API](http://developer.github.com/v3/issues/#list-issues-for-a-repository)
+is nice, but if you try to get all the issues of a project you will have a hard
+time. You will need to query page by page and get open and closed issues
+separately.
+
+Also, if you want to find out the total number of issues, there is no easy way
+of doing it. You can't find out the amount of open issues through the
+[repositories API](http://developer.github.com/v3/repos/#get)
+but, where are the closed ones?
+
+
+## Features
+
+Hexabat tackles those two problems by providing  an easy way of importing
+the issues of a Github repository:
+
+```ruby
+Hexabat.on_issue_retrieved do |issue|
+  puts "issue ##{issue['number']} imported"
+end
+
+Hexabat.on_issue_count_known do |count|
+  puts "The repository has #{count} issues"
+end
+
+Hexabat.on_error do |repo, status, message|
+  STDERR.puts "Failed to import #{repo} due to #{status}: #{message}"
+end
+
+Hexabat.import 'rails/rails'
+```
+
+That means that Hexabat will allow you to:
+
+* **Find out the total number of issues** (both open and closed) of the repository.
+* **Do something with the data of every issue in the repository** (i.e. store it in a database).
+* **Handle importing errors properly** (i.e. store the error reason in a database)
+
+You don't need set every single callback if you don't want to. You can setup only one
+callback if that's what you need. We also provide a default `errback` that will
+print to `STDERR` a message with the failure (pretty similar to the example above).
+
+
+
+###Authentication
+
+If you are importing a public repository's issues you don't need to authenticate:
+
+```ruby
+Hexabat.import 'rails/rails'
+```
+
+If you want to import issues on behalf of a user you authenticated with OAuth
+you can use her token in order to do it:
+
+```ruby
+Hexabat.import 'path11/private_repo', token: auth_token
+```
+
+
+## EventMachine integration
+
+Hexabat runs on top of
+[EventMachine](https://github.com/eventmachine/eventmachine).
+
+You can use it inside a running event loop:
+
+```ruby
+EM.run do
+  Hexabat.on_issue_retrieved   { |issue| puts "issue ##{issue['number']} imported" }
+  Hexabat.on_issue_count_known { |count| puts "The repository has #{count} issues" }
+  Hexabat.import 'rails/rails' # this won't start an event loop
+end
+```
+
+Hexabat will start the event loop for you if you call it outside a running one.
+
+
+### Does Hexabat stop the event loop?
+
+No it doesn't. Given that Hexabat doesn't know the work you are going to do
+with each of the issues it doesn't know when it's work will be done. For
+example: if you use
+[em-mongo](https://github.com/bcg/em-mongo)
+to store each issue Hexabat can't know when each of those callbacks is done.
+
+**It's your job to** sync them up and **stop the event loop**.
+
+
+## What's next?
+
+There are a few tweaks and improvements that we want to add to Hexabat:
+
+* Being able to provide an OAuth tokens, and keys so you can authorize your
+application without the need of a user OAuth token.
+
+After that we have a few more things planned but that will be a surprise.

data/Rakefile

@@ -0,0 +1,32 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+namespace :cucumber do
+  Cucumber::Rake::Task.new(:ok,  'Run features that should pass') do |t|
+    t.cucumber_opts = ['--strict', '--tags ~@wip', '--format progress']
+  end
+
+  Cucumber::Rake::Task.new(:wip, 'Run features that are being worked on') do |t|
+    t.cucumber_opts = ['--wip', '--tags @wip']
+  end
+
+  Cucumber::Rake::Task.new(:all, 'Run all features')
+end
+
+namespace :rspec do
+  desc 'Run specs with progress output'
+  RSpec::Core::RakeTask.new(:progress) do |t|
+    t.rspec_opts = '--format progress'
+  end
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec)
+end
+
+task spec:     'rspec:spec'
+task cucumber: 'cucumber:ok'
+task test:     ['rspec:progress', 'cucumber:ok']
+task default:  'test'

data/features/callbacks.feature

@@ -0,0 +1,21 @@
+#language: en
+
+Feature: Callbacks
+
+  Scenario: A single issue is retrieved and the callback is called.
+    Given there is a single open issue on "path11/hexabat"
+     When I set up an issue retrieved callback
+      And I import the "path11/hexabat" repository
+     Then the callback is called with the issue in that repository
+
+  Scenario: The number of issues is found out and the callback is called.
+    Given there are 101 open issues and 300 closed issues on "path11/hexabat"
+     When I setup the issue count known callback
+      And I import the "path11/hexabat" repository
+     Then the callback is called with the number of issues of the repository
+
+  Scenario: The repository can't be imported and the errback is called.
+    Given the repository "path11/rails" doesn't exist
+     When I setup the errback
+      And I import the "path11/rails" repository
+     Then the errback is called with the error message