embratel 0.0.1 → 0.0.2

data/README.org

@@ -3,17 +3,75 @@
 #+BEGIN_SRC
 gem install embratel
 #+END_SRC
-** Testando
-   Para rodar os testes você precisa ter o
-   [[http://github.com/carlhuda/bundler][bundler]] instalado.
+   Você precisa ter o ruby e o rubygems instalados.
+
+** Uso
+   A Embratel fornece faturas de conta de telefone em seu
+   [[http://fatura.embratel.net.br/embratel/index.html][serviço online]].
+   Para extrair informações sobre uma fatura, você precisará do arquivo
+   .csv de um dado mês.
+*** Como obter o arquivo da fatura?
+    - [[http://fatura.embratel.net.br/embratel/jsp/selectClientRegister.jsp][cadastre-se]] se você não possui uma conta
+    - logue no site
+    - escolha o mês da fatura
+    - vá em 'Opções' e selecione 'Exportar toda a conta'
+    - exporte como 'Excel - CSV'
+
+*** Classes da gem
+#+BEGIN_SRC
+Embratel::PhoneBill
+Embratel::Call
+#+END_SRC
+
+*** Com o arquivo da fatura você pode
+#+BEGIN_SRC
+phone_bill = Embratel::PhoneBill.new("/path/to/fatura.csv")
+
+# array com todas as ligações da fatura (array de objetos Embratel::Call)
+phone_bill.calls
+
+# custo total da fatura
+phone_bill.total
+#+END_SRC
+
+*** attr_accessors disponíveis para objetos Embratel::Call
+#+BEGIN_SRC
+id
+caller
+description
+date
+number_called
+caller_local
+called_local
+start_time
+end_time
+imp
+country
+quantity
+unit
+cost
+#+END_SRC
+
+** Para rodar os testes
+*** Pegue o código
+#+BEGIN_SRC
+git clone git://github.com/murilasso/embratel.git
+cd embratel
+#+END_SRC
+
+*** Instale o bundler e as dependências (se já não estiverem instaladas)
 #+BEGIN_SRC
 gem install bundler
 bundle install
+#+END_SRC
+
+*** Rode os testes
+#+BEGIN_SRC
 rake test
 #+END_SRC
 
 ** Autor
-   [[mailto:murilo.soares3@gmail.com][Murilo Soares Pereira]].
+   [[http://www.comp.ufscar.br/~murilo][Murilo Soares Pereira]]
 
 ** Licença
    Distribuído sob a [[http://github.com/murilasso/embratel/blob/master/MIT-LICENSE][licença MIT]].

data/embratel.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path("../lib/embratel/version", __FILE__)
+require File.expand_path("../lib/embratel", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "embratel"
@@ -8,8 +8,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Murilo Soares Pereira"]
   s.email       = ["murilo.soares3@gmail.com"]
   s.homepage    = "http://github.com/murilasso/embratel"
-  s.summary     = "Gem for extracting information from Embratel's phone bill files."
-  s.description = ""
+  s.summary     = "Extract calls information from Embratel's phone bill files."
 
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "embratel"

data/lib/embratel.rb

@@ -1,20 +1,8 @@
-require 'rubygems'
-
-begin
-  require 'bundler'
-rescue LoadError
-  STDERR.puts "You need to install bundler"
-else
-  begin
-    Bundler.setup
-  rescue Bundler::BundlerError
-    STDERR.puts $!
-  end
-end
-
 require 'embratel/phone_bill'
 require 'embratel/call'
 
 module Embratel
+  VERSION = "0.0.2"
+
   class InvalidPhoneBillFileError < StandardError; end
 end

data/lib/embratel/phone_bill.rb

@@ -12,7 +12,7 @@ module Embratel
       rescue FasterCSV::MalformedCSVError
         raise
       else
-        raise InvalidPhoneBillFileError if invalid_rows?
+        raise InvalidPhoneBillFileError if (invalid_rows? || non_csv?(path))
       end
     end
 
@@ -28,10 +28,15 @@ module Embratel
     end
 
     private
+
     def invalid_rows?
       csv = @csv.dup
       3.times  { csv.shift }
       csv.any? { |row| !Call.new(row).valid? }
     end
+
+    def non_csv?(path)
+      File.extname(path) != '.csv'
+    end
   end
 end

data/test/embratel/phone_bill_test.rb

@@ -23,6 +23,10 @@ class Embratel::PhoneBillTest < Test::Unit::TestCase
     "#{FIXTURES_PATH}/valid_phone_bill_file.csv"
   end
 
+  def non_csv_phone_bill_file_path
+    "#{FIXTURES_PATH}/phone_bill.txt"
+  end
+
   def test_phone_bill_instantiation_with_a_non_existing_file_path
     assert_raise(Errno::ENOENT) { Embratel::PhoneBill.new(non_existing_file_path) }
   end
@@ -43,6 +47,12 @@ class Embratel::PhoneBillTest < Test::Unit::TestCase
     end
   end
 
+  def test_does_not_allow_other_file_extensions_than_csv
+    assert_raise(Embratel::InvalidPhoneBillFileError) do
+      Embratel::PhoneBill.new(non_csv_phone_bill_file_path)
+    end
+  end
+
   def test_phone_bill_instantiation_with_a_valid_csv_phone_bill_file_path
     phone_bill = Embratel::PhoneBill.new(valid_csv_phone_bill_file_path)
     assert(!phone_bill.send(:invalid_rows?))

data/test/test_helper.rb

@@ -1,7 +1,8 @@
-require 'test/unit'
 
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'rubygems'
 require 'embratel'
+require 'test/unit'
 
 class Test::Unit::TestCase
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: embratel
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Murilo Soares Pereira
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-16 00:00:00 -03:00
+date: 2010-11-05 00:00:00 -02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,7 +66,7 @@ dependencies:
         version: 1.5.3
   type: :runtime
   version_requirements: *id003
-description: ""
+description: 
 email: 
 - murilo.soares3@gmail.com
 executables: []
@@ -86,10 +86,10 @@ files:
 - lib/embratel.rb
 - lib/embratel/call.rb
 - lib/embratel/phone_bill.rb
-- lib/embratel/version.rb
 - test/embratel/call_test.rb
 - test/embratel/phone_bill_test.rb
 - test/fixtures/invalid_phone_bill_file.csv
+- test/fixtures/phone_bill.txt
 - test/fixtures/text_file.txt
 - test/fixtures/valid_phone_bill_file.csv
 - test/test_helper.rb
@@ -128,6 +128,6 @@ rubyforge_project: embratel
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Gem for extracting information from Embratel's phone bill files.
+summary: Extract calls information from Embratel's phone bill files.
 test_files: []
 

data/lib/embratel/version.rb

@@ -1,3 +0,0 @@
-module Embratel
-  VERSION = "0.0.1"
-end