logs_tf 0.0.1 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30923ae1e7445c66b59097c54b9639f48f5b21a066e229fa674fb8ee12256ef7
+  data.tar.gz: 3ad1b46201a4a14f7c684d4ee133f5b46f11d3db24c58ce76e8c90b52fe77dea
+SHA512:
+  metadata.gz: c52eb061d1e5beb06541866e1582eae8c6b56510d2c53f7b3edf494a49028dde6a12724148a91057f3c943cc032af51ecd839223dbd87e992535ba14d5ba3f17
+  data.tar.gz: 4d885017a0e6328f2f923bc96fa820ef2a12d8ab33c6e1177b6d8963b7c700952ff5660c6726f36afecafb8864a8d8b35c59fcaa4b8620b5d6c098fb84901a27

data/.coverage

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+SimpleCov.start

data/.gitignore

@@ -11,6 +11,10 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+rspec.html
+
+# RBX files
+.rbx/
 
 # YARD artifacts
 .yardoc

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - rbx-19mode
+script: ./script/ci

data/Gemfile.lock

@@ -1,43 +1,85 @@
 PATH
   remote: .
   specs:
-    logs_tf (0.0.0)
-      faraday (~> 0.8.0)
-      multipart-post (~> 1.1.0)
+    logs_tf (0.0.5)
+      faraday (~> 1.0)
+      multipart-post (>= 1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ZenTest (4.9.0)
-    coderay (1.0.8)
-    diff-lcs (1.1.3)
-    faraday (0.8.5)
-      multipart-post (~> 1.1)
-    method_source (0.8.1)
-    multipart-post (1.1.5)
-    pry (0.9.11.4)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    pry-nav (0.2.3)
-      pry (~> 0.9.10)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
-    slop (3.4.3)
-    vcr (2.4.0)
+    coderay (1.1.3)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    json (2.6.1)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-nav (1.0.0)
+      pry (>= 0.9.10, < 0.15)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    ruby2_keywords (0.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.1.0)
+    tins (1.29.1)
+      sync
+    vcr (6.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  ZenTest (~> 4.9.0)
+  coveralls
   logs_tf!
-  pry-nav (~> 0.2.3)
-  rspec (~> 2.12.0)
-  vcr (~> 2.4.0)
+  pry-nav
+  rspec
+  vcr
+
+BUNDLED WITH
+   2.2.32

data/README.md

@@ -1,4 +1,36 @@
-Logs.tf
-=======
+# Logs.tf interface [![Build Status](https://secure.travis-ci.org/Arie/logs_tf.png)](http://travis-ci.org/Arie/logs_tf) [![Dependencies](https://gemnasium.com/Arie/logs_tf.png)](https://gemnasium.com/Arie/logs_tf.png) [![Code Climate](https://codeclimate.com/github/Arie/logs_tf.png)](https://codeclimate.com/github/Arie/logs_tf) [![Coverage Status](https://coveralls.io/repos/github/Arie/logs_tf/badge.svg?branch=master)](https://coveralls.io/r/Arie/logs_tf) 
 
-Gem for the logs.tf API
+A gem for the logs.tf API
+
+## Usage
+
+- Get an account and API key on [logs.tf](http://logs.tf)
+- Set a constant called LogsTF:API_KEY or use it as an argument in the next step
+- Create a log object.
+
+```ruby
+log = LogsTF::Log.new(File.open('logfile.log'), 'map_name', 'title', 'api_key')
+```
+
+- Create the upload object: 
+
+```ruby
+upload = LogsTF::Upload.new(log)
+```
+
+- If there something wrong an error will be raised which you can rescue and inspect the message of:
+
+```ruby
+begin
+  upload.send
+rescue Exception => e
+  puts "The error is #{e.message}"
+end
+```
+
+- If everthing's alright, you can get the URL to the uploaded log:
+
+```ruby
+  upload.send
+  upload.url
+```

data/lib/logs_tf/upload.rb

@@ -37,12 +37,28 @@ module LogsTF
         NotAuthenticatedError
       when "Invalid API key"
         InvalidAPIKeyError
+      when "Log has no valid rounds (at least one needed)"
+        NoValidRoundsError
+      when "Not enough players (2 needed)"
+        NotEnoughPlayersError
+      when "Log is empty"
+        LogIsEmptyError
+      when /^Parsing failed in line \d+$/
+        ParsingFailedError
+      when "Missing API key or login"
+        MissingAPIKeyOrLoginError
+      when "Guru Meditation"
+        GuruMeditationError
+      else
+        UnknownLogsTfError
       end
 
       raise error_class, response_body["error"]
     end
 
-    private
+    def error
+      response_body["error"]
+    end
 
     def response_body
       @response_body ||= JSON.parse(response.body)
@@ -56,9 +72,7 @@ module LogsTF
       response.status == 200
     end
 
-    def error
-      response_body["error"]
-    end
+    private
 
     def post_options
       { :key      => api_key,
@@ -97,6 +111,13 @@ module LogsTF
     class MissingLogError < Error; end
     class NotAuthenticatedError < Error; end
     class InvalidAPIKeyError < Error; end
+    class NoValidRoundsError < Error; end
+    class NotEnoughPlayersError < Error; end
+    class LogIsEmptyError < Error; end
+    class ParsingFailedError < Error; end
+    class MissingAPIKeyOrLoginError < Error; end
+    class GuruMeditationError < Error; end
+    class UnknownLogsTfError < Error; end
 
   end
 

data/lib/logs_tf/version.rb

@@ -1,3 +1,3 @@
 module LogsTF
-  VERSION = "0.0.1"
+  VERSION = "0.0.5"
 end

data/logs_tf.gemspec

@@ -4,7 +4,7 @@ require File.expand_path('../lib/logs_tf/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.name          = 'logs_tf'
   gem.version       = LogsTF::VERSION
-  gem.date          = '2013-02-10'
+  gem.date          = '2013-11-13'
   gem.summary       = "Logs.tf"
   gem.description   = "A gem to interface with the logs.tf API"
   gem.authors       = ["Arie"]
@@ -14,11 +14,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.homepage      = 'http://github.com/Arie/logs_tf'
 
-  gem.add_dependency "faraday",         "~> 0.8.0"
-  gem.add_dependency "multipart-post",  "~> 1.1.0"
+  gem.add_dependency "faraday",         "~> 1.0"
+  gem.add_dependency "multipart-post",  ">= 1.2.0"
 
-  gem.add_development_dependency "vcr",      "~> 2.4.0"
-  gem.add_development_dependency "pry-nav",  "~> 0.2.3"
-  gem.add_development_dependency "rspec",    "~> 2.12.0"
-  gem.add_development_dependency "ZenTest",  "~> 4.9.0"
+  gem.add_development_dependency "vcr"
+  gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency "pry-nav"
+  gem.add_development_dependency "rspec"
 end

data/script/bundler

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -e
+
+echo "--- Making sure bundler is installed"
+
+gem which bundler &> /dev/null || gem install bundler --no-ri --no-rdoc
+
+echo "--- Installing gems"
+
+bundle check --no-color || time bundle install --no-color

data/script/ci

@@ -0,0 +1,22 @@
+run() {
+  time bundle exec $*
+}
+
+echo "--- Starting continuous integration build"
+
+./script/bundler
+
+if [[ -d coverage ]]; then
+  echo "Removing old coverage report"
+  rm -r coverage
+fi
+
+echo "--- Running RSpec"
+
+run rspec --color spec --format progress --format html --out rspec.html
+rspec=$?
+
+if [[ $rspec -ne 0 ]]; then
+  echo "--- Some tests have failed."
+  exit 1
+fi

data/spec/logs_tf/upload_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'pry-nav'
 
 module LogsTF
 
@@ -10,66 +11,113 @@ module LogsTF
     let(:upload)      { Upload.new(log, logs_tf_url ) }
 
 
-    vcr_options = { :cassette_name => "upload", :record => :new_episodes, :match_requests_on => [:method, :uri, :body] }
+    vcr_options = { :cassette_name => "upload", :record => :none, :match_requests_on => [:method, :uri] }
     context "uploading logfiles", :vcr => vcr_options do
 
       describe "#send" do
 
         it "knows the status of the request" do
           upload.send
-          upload.should be_request_success
+          expect(upload).to be_request_success
         end
 
         it "knows if tf.logs was able to parse the log" do
           upload.send
-          upload.should be_upload_success
+          expect(upload).to be_upload_success
         end
 
         it "knows the log's location after sending" do
           upload.send
-          upload.url.should == "#{logs_tf_url}/91"
+          expect(upload.url).to eql "#{logs_tf_url}/91"
         end
 
         it "raises the appropriate error when upload was unsuccessful" do
-          upload.stub(:connection => stub(:connection).as_null_object)
-          upload.stub(:request_success? => true)
-          upload.stub(:upload_success? => false)
-          upload.should_receive(:raise_logs_tf_error)
+          expect(upload).to receive(:connection).and_return(double(:connection).as_null_object)
+          expect(upload).to receive(:request_success?).and_return(true)
+          expect(upload).to receive(:upload_success?).and_return(false)
+          expect(upload).to receive(:raise_logs_tf_error)
           upload.send
         end
 
         it "raises an error when the response status is not 200" do
-          upload.stub(:connection => stub(:connection).as_null_object)
-          upload.stub(:request_success? => false)
+          expect(upload).to receive(:connection).and_return(double(:connection).as_null_object)
+          expect(upload).to receive(:request_success?).and_return(false)
           expect{upload.send}.to raise_error Upload::RequestError
         end
 
       end
 
+      describe '#error' do
+        before { expect(upload).to receive(:response).and_return(double(body: '{ "error": "foobar" }')) }
+
+        it "parses the JSON respone from logs.tf for the error message" do
+          expect(upload.error).to eql 'foobar'
+        end
+
+      end
+
       describe '#raise_logs_tf_error' do
 
-        before { upload.stub(:response => stub(:body => '{ "error": "foobar" }')) }
+        before { expect(upload).to receive(:response).and_return(double(body: '{ "error": "foobar" }')) }
 
         it "raises InvalidLogError" do
-          upload.stub(:error => "Invalid log file")
+          expect(upload).to receive(:error).and_return("Invalid log file")
           expect{upload.raise_logs_tf_error}.to raise_error Upload::InvalidLogError
         end
 
         it "raises MissingLogError" do
-          upload.stub(:error => "No file")
+          expect(upload).to receive(:error).and_return("No file")
           expect{upload.raise_logs_tf_error}.to raise_error Upload::MissingLogError
         end
 
         it "raises NotAuthenticatedError" do
-          upload.stub(:error => "Not authenticated")
+          expect(upload).to receive(:error).and_return("Not authenticated")
           expect{upload.raise_logs_tf_error}.to raise_error Upload::NotAuthenticatedError
         end
 
         it "raises InvalidAPIKeyError" do
-          upload.stub(:error => "Invalid API key")
+          expect(upload).to receive(:error).and_return("Invalid API key")
           expect{upload.raise_logs_tf_error}.to raise_error Upload::InvalidAPIKeyError
         end
 
+        it "raises NoValidRoundsError" do
+          expect(upload).to receive(:error).and_return("Log has no valid rounds (at least one needed)")
+          expect{upload.raise_logs_tf_error}.to raise_error Upload::NoValidRoundsError
+        end
+
+        it "raises NotEnoughPlayersError" do
+          expect(upload).to receive(:error).and_return("Not enough players (2 needed)")
+          expect{upload.raise_logs_tf_error}.to raise_error Upload::NotEnoughPlayersError
+        end
+
+        it "raises LogIsEmptyError" do
+          expect(upload).to receive(:error).and_return("Log is empty")
+          expect{upload.raise_logs_tf_error}.to raise_error Upload::LogIsEmptyError
+        end
+
+        it "raises ParsingFailedError" do
+          expect(upload).to receive(:error).and_return("Parsing failed in line 123")
+          expect{upload.raise_logs_tf_error}.to raise_error Upload::ParsingFailedError
+
+          expect(upload).to receive(:error).and_return("Parsing failed in line 456")
+          expect{upload.raise_logs_tf_error}.to raise_error Upload::ParsingFailedError
+        end
+
+        it "raises MissingAPIKeyOrLoginError" do
+          expect(upload).to receive(:error).and_return("Missing API key or login")
+          expect{upload.raise_logs_tf_error}.to raise_error Upload::MissingAPIKeyOrLoginError
+        end
+
+        it "raises GuruMeditationError" do
+          expect(upload).to receive(:error).and_return("Guru Meditation")
+          expect{upload.raise_logs_tf_error}.to raise_error Upload::GuruMeditationError
+        end
+
+        it "raises UnknownLogsTFError" do
+          expect(upload).to receive(:error).and_return("Foobar")
+          expect{upload.raise_logs_tf_error}.to raise_error Upload::UnknownLogsTfError
+        end
+
       end
 
     end

data/spec/spec_helper.rb

@@ -1,3 +1,12 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
 require "logs_tf"
 require "pry-nav"
 require "vcr"

metadata

@@ -1,121 +1,110 @@
 --- !ruby/object:Gem::Specification
 name: logs_tf
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.0.5
 platform: ruby
 authors:
 - Arie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-nav
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: ZenTest
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.9.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.9.0
+        version: '0'
 description: A gem to interface with the logs.tf API
 email: rubygems@ariekanarie.nl
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .autotest
-- .gitignore
-- .rspec
+- ".autotest"
+- ".coverage"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -124,6 +113,8 @@ files:
 - lib/logs_tf/upload.rb
 - lib/logs_tf/version.rb
 - logs_tf.gemspec
+- script/bundler
+- script/ci
 - spec/fixtures/logs/broder_vs_epsilon.log
 - spec/fixtures/logs/broken_log.log
 - spec/fixtures/vcr/upload.yml
@@ -131,27 +122,25 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/Arie/logs_tf
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 3.2.32
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Logs.tf
 test_files:
 - spec/fixtures/logs/broder_vs_epsilon.log