hexabat 0.0.1

data/spec/hexabat/importer_spec.rb

@@ -0,0 +1,36 @@
+require 'hexabat/importer'
+
+describe Hexabat::Importer do
+  subject               { described_class.new counter, request_creator }
+  let(:counter)         { stub :issue_counter }
+  let(:request_creator) { stub :page_request_creator }
+
+  let(:issue_count)     { stub :issue_count }
+
+  it 'imports the first page of open and closed issues' do
+    request_creator.should_receive(:for).with(page: 1, state: 'open')
+    request_creator.should_receive(:for).with(page: 1, state: 'closed')
+    subject.import
+  end
+
+  it 'counts issues and reports pages in the repository' do
+    page_range = stub(:page_range, multiple_pages?: false)
+    counter.should_receive(:counted).with(:first, :open, page_range, issue_count)
+    subject.first_page_retrieved(:open).call(page_range, issue_count)
+  end
+
+  it 'imports the last page of issues' do
+    page_range = stub(:page_range, multiple_pages?: true, last: 4)
+    counter.should_receive(:counted).with(:first, :open, page_range, issue_count)
+    request_creator.should_receive(:for).with(page: 4, state: 'open')
+    subject.first_page_retrieved(:open).call(page_range, issue_count)
+  end
+
+  it 'counts issues and imports the remaining pages' do
+    page_range = stub(:page_range, middle: 2..3)
+    counter.should_receive(:counted).with(:last, :open, page_range, issue_count)
+    request_creator.should_receive(:for).with(page: 2, state: 'open')
+    request_creator.should_receive(:for).with(page: 3, state: 'open')
+    subject.last_page_retrieved(:open).call(page_range, issue_count)
+  end
+end

data/spec/hexabat/issue_count_spec.rb

@@ -0,0 +1,42 @@
+require 'hexabat/issue_count'
+
+describe Hexabat::IssueCount do
+  subject                 { described_class.new &issue_count_known }
+  let(:issue_count_known) { lambda{|count| @count = count} }
+
+  it 'keeps track of the notified page ranges' do
+    subject.page_ranges.should eq Hash[open: nil, closed: nil]
+  end
+
+  it 'keeps track of the notified issue counts' do
+    initial_count = {
+      open:   { first: nil, last: nil },
+      closed: { first: nil, last: nil }
+    }
+    subject.issue_counts.should eq initial_count
+  end
+
+  it 'can be notified with issue counts and page ranges' do
+    page_range = stub(:page_range, multiple_pages?: true)
+    subject.counted :first, :open, page_range, 10
+    subject.page_ranges.should eq Hash[open: page_range, closed: nil]
+    expected_count = {open: {first: 10, last: nil}, closed: {first: nil, last: nil}}
+    subject.issue_counts.should eq expected_count
+  end
+
+  it 'updates issue counts if there is only one page' do
+    page_range = stub(:page_range, multiple_pages?: false, middle_page_count: 0)
+    subject.counted :first, :open, page_range, 2
+    expected_count = {open: {first: 2, last: 0}, closed: {first: nil, last: nil}}
+    subject.issue_counts.should eq expected_count
+  end
+
+  it 'calls the provided callback when done counting' do
+    open_page_range   = stub(:page_range, multiple_pages?: false, middle_page_count: 0)
+    closed_page_range = stub(:page_range, multiple_pages?: true, middle_page_count: 2)
+    subject.counted :first, :open, open_page_range, 15
+    subject.counted :first, :closed, closed_page_range, 100
+    subject.counted :last, :closed, closed_page_range,  10
+    @count.should be 325
+  end
+end

data/spec/hexabat/page_range_spec.rb

@@ -0,0 +1,121 @@
+require 'hexabat/page_range'
+
+describe Hexabat::PageRange do
+  context 'building page ranges from headers' do
+    it 'creates a SinglePageRange if there is only one page' do
+      headers = { 'NO LINK' => '' }
+      Hexabat::SinglePageRange.should_receive(:new).with(1)
+      described_class.from(headers)
+    end
+
+    it 'creates a MultiplePageRange if there is more than one page' do
+      headers = { 'LINK' => '<https://xxx.com?page=2&per_page=100>; rel="next", <https://xxx.com?page=5&per_page=100>; rel="last"' }
+      Hexabat::MultiplePageRange.should_receive(:new).with(1, 5)
+      described_class.from(headers)
+    end
+  end
+end
+
+describe Hexabat::PageRange::LinkHeader do
+  it 'extracts the last page from the LINK header' do
+    link = '<https://xxx.com?page=2&per_page=100>; rel="next", <https://xxx.com?page=8&per_page=100>; rel="last"'
+    described_class.new(link).last.should be 8
+  end
+
+  it 'calculates the last page from the LINK header when last is present' do
+    link = '<https://xxx.com?page=1&per_page=100&state=closed>; rel="last", <https://xxx.com?page=1&per_page=100&state=closed>; rel="first", <https://xxx.com?page=73&per_page=100&state=closed>; rel="prev"'
+    described_class.new(link).last.should be 74
+  end
+
+  it 'calculates the last page from the LINK header when last is missing' do
+    link = '<https://xxx.com?page=1&per_page=100&state=closed>; rel="first", <https://xxx.com?page=73&per_page=100&state=closed>; rel="prev"'
+    described_class.new(link).last.should be 74
+  end
+end
+
+describe Hexabat::MultiplePageRange do
+  it 'knows the first page' do
+   described_class.new(3, 5).first.should be 3
+  end
+
+  it 'knows the page count' do
+    described_class.new(1, 2).page_count.should be 2
+    described_class.new(5, 9).page_count.should be 5
+  end
+
+  it 'knows the last page' do
+   described_class.new(1, 5).last.should be 5
+  end
+
+  it 'knows the middle pages' do
+    described_class.new(1, 2).middle.should eq 0...0
+    described_class.new(1, 9).middle.should eq 2..8
+  end
+
+  it 'knows the middle pages count' do
+    described_class.new(1, 2).middle_page_count.should eq 0
+    described_class.new(1, 9).middle_page_count.should eq 7
+  end
+
+  it 'knows if it has more than one page' do
+    described_class.new(1, 2).multiple_pages?.should be_true
+    described_class.new(1, 5).multiple_pages?.should be_true
+  end
+end
+
+describe Hexabat::SinglePageRange do
+  subject    { described_class.new page }
+  let(:page) { 2 }
+
+  it 'knows the first page' do
+   subject.first.should be 2
+  end
+
+  it 'knows the page count' do
+    subject.page_count.should be 1
+  end
+
+  it 'knows the last page' do
+    subject.last.should be 2
+  end
+
+  it 'knows the middle pages' do
+    subject.middle.should eq 0...0
+  end
+
+  it 'knows the middle pages count' do
+    subject.middle_page_count.should eq 0
+  end
+
+  it 'knows if it has more than one page' do
+    subject.multiple_pages?.should be_false
+  end
+end
+
+describe Hexabat::EmptyPageRange do
+  subject    { described_class.new }
+
+  it 'knows the first page' do
+   subject.first.should be 0
+  end
+
+  it 'knows the page count' do
+    subject.page_count.should be 0
+  end
+
+  it 'knows the last page' do
+    subject.last.should be 0
+  end
+
+  it 'knows the middle pages' do
+    subject.middle.should eq 0...0
+  end
+
+  it 'knows the middle pages count' do
+    subject.middle_page_count.should eq 0
+  end
+
+  it 'knows if it has more than one page' do
+    subject.multiple_pages?.should be_false
+  end
+end

data/spec/hexabat/page_request_buider_spec.rb

@@ -0,0 +1,47 @@
+require 'hexabat/page_request_builder'
+
+describe 'Page request builders' do
+  let(:repository)         { 'path11/hexabat' }
+  let(:response_processor) { mock :response_processor }
+
+  let(:http)     { stub :http }
+  let(:get)      { stub(:get).as_null_object }
+  let(:endpoint) { 'https://api.github.com/repos/path11/hexabat/issues' }
+  let(:query)    { Hash[page: 1, per_page: 100, state: 'open'] }
+
+  before { EM::HttpRequest.stub(:new).with(endpoint).and_return(http) }
+
+  shared_examples_for 'a page request builder' do
+    it 'builds an EM::HttpRequest to retrieve the page' do
+      subject.for(page: 1, state: 'open').should eq get
+    end
+
+    it 'sets up the callback to process the response' do
+      page_callback = lambda{}
+      get.stub(:callback).and_yield(http)
+      response_processor.should_receive(:process).with(http, &page_callback)
+      subject.for(page: 1, state: 'open')
+    end
+  end
+
+  describe Hexabat::PageRequestBuilder::Unauthorized do
+    subject { Hexabat::PageRequestBuilder.for repository, response_processor }
+
+    before { http.stub(:get).with(query: query).and_return(get) }
+
+    it_behaves_like 'a page request builder'
+  end
+
+  describe Hexabat::PageRequestBuilder::TokenAuthorized do
+    subject     { Hexabat::PageRequestBuilder.for repository, response_processor, token: token }
+    let(:token) { 'xxxx' }
+
+    before do
+      headers = { 'Authorization' => "token #{token}" }
+      http.stub(:get).with(query: query, head: headers).and_return(get)
+    end
+
+    it_behaves_like 'a page request builder'
+  end
+
+end

data/spec/hexabat/page_response_processor_spec.rb

@@ -0,0 +1,42 @@
+require 'hexabat/page_response_processor'
+
+describe Hexabat::PageResponseProcessor do
+  subject          { described_class.new repository, callback, errback }
+  let(:repository) { 'path11/hexabat' }
+  let(:callback)   { lambda{} }
+  let(:errback)    { lambda{} }
+
+  let(:http)    { stub(:http, response: issues, response_header: headers) }
+  let(:issues)  { [:issue1, :issue2] }
+  let(:headers) { stub(:headers, status: 200) }
+
+  it 'yields every issue in the response to the callback' do
+    EM.stub(:next_tick).and_yield
+    callback.should_receive(:call).with(:issue1)
+    callback.should_receive(:call).with(:issue2)
+    subject.process(http)
+  end
+
+  it 'can be set with a callback for when the whole page is retrieved' do
+    page_range = stub(:page_range)
+    Hexabat::PageRange.stub(:from).with(headers).and_return(page_range)
+    page_callback = lambda{}
+    page_callback.should_receive(:call).with(page_range, issues.count)
+    subject.process(http, &page_callback)
+  end
+
+  it 'calls the errback if the repository is a fork' do
+    headers.stub(:status).and_return(410)
+    http.stub(:response).and_return('message' => 'Issues are disabled for this repo')
+    errback.should_receive(:call).with(repository, 410, 'Issues are disabled for this repo')
+    subject.process(http)
+  end
+
+  it 'calls the errback if the repository is a missing' do
+    headers.stub(:status).and_return(404)
+    http.stub(:response).and_return('message' => 'Not Found')
+    errback.should_receive(:call).with(repository, 404, 'Not Found')
+    subject.process(http)
+  end
+
+end

data/spec/hexabat_spec.rb

@@ -0,0 +1,23 @@
+require 'hexabat'
+
+describe Hexabat do
+  let(:issue_retrieved)   { lambda {|issue|} }
+  let(:issue_count_known) { lambda {|count|} }
+  let(:error_occurred)    { lambda {|repository, status, message|} }
+
+  before do
+    Hexabat.on_issue_retrieved   &issue_retrieved
+    Hexabat.on_issue_count_known &issue_count_known
+    Hexabat.on_error             &error_occurred
+  end
+
+  it 'imports the repository'  do
+    client = mock
+    Hexabat::Client.stub(:new).with('path11/hexabat', {}).and_return(client)
+    client.should_receive(:on).with(issue_retrieved: issue_retrieved)
+    client.should_receive(:on).with(issue_count_known: issue_count_known)
+    client.should_receive(:on).with(error: error_occurred)
+    client.should_receive(:import)
+    Hexabat.import 'path11/hexabat'
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: hexabat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- path11
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Github issues importing tool
+email:
+- alberto@path11.com
+- ecomba@path11.com
+- javier@path11.com
+- sebastian@path11.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/callbacks.feature
+- features/fixtures/100_open_issues.rb
+- features/fixtures/300_closed_issues.rb
+- features/fixtures/single_open_issue.rb
+- features/step_definitions/callbacks.rb
+- features/support/env.rb
+- hexabat.gemspec
+- lib/hexabat.rb
+- lib/hexabat/client.rb
+- lib/hexabat/importer.rb
+- lib/hexabat/issue_count.rb
+- lib/hexabat/page_range.rb
+- lib/hexabat/page_request_builder.rb
+- lib/hexabat/page_response_processor.rb
+- lib/hexabat/version.rb
+- spec/hexabat/client_spec.rb
+- spec/hexabat/importer_spec.rb
+- spec/hexabat/issue_count_spec.rb
+- spec/hexabat/page_range_spec.rb
+- spec/hexabat/page_request_buider_spec.rb
+- spec/hexabat/page_response_processor_spec.rb
+- spec/hexabat_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2707408037992863866
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2707408037992863866
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! 'Importing all the issues of a Github repository is a complex task: the
+  Github API does not provide an easy way of doing it. Hexabat will help you with
+  that. It will allow you to find out the total number of issues (counting both open
+  and closed ones) and to perform an action with each one of them.'
+test_files:
+- features/callbacks.feature
+- features/fixtures/100_open_issues.rb
+- features/fixtures/300_closed_issues.rb
+- features/fixtures/single_open_issue.rb
+- features/step_definitions/callbacks.rb
+- features/support/env.rb
+- spec/hexabat/client_spec.rb
+- spec/hexabat/importer_spec.rb
+- spec/hexabat/issue_count_spec.rb
+- spec/hexabat/page_range_spec.rb
+- spec/hexabat/page_request_buider_spec.rb
+- spec/hexabat/page_response_processor_spec.rb
+- spec/hexabat_spec.rb