postmon_ruby 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff5b09bd792c1b13f2df53c3a5e500c06ca3eff9
-  data.tar.gz: 8e6400cf6705e415d68e1fe5b958e670d5ab7240
+  metadata.gz: 39598f0c0e34c0e99ff6c54aea8b765776b5135f
+  data.tar.gz: a0bd6342d7a753619d76d06663c9ee64124e0b07
 SHA512:
-  metadata.gz: 693631c654886c4595a88e8d685ba24e05a63a0a7b691d4c90e209cbab147b7b13cac951ef3a75a2e22b9fdb412e5feddccf04e9416436dd347d9f1a430f7eff
-  data.tar.gz: bdcb4c8e14479ff2985dc0ec37fcfdee0e4d4d8b8d9546c23f83467facdc35e902b840ed25aa34ac76eb2e1122788912a52e57bf0ad4a33acb4c3d2bd35ac97a
+  metadata.gz: 702c005ee15983c85e1d15791317fa26e506eafcb0d3a40f0a6fae9b1d36c8d4ebd3ecaa00b473957e836aafc869048065de26d3a203ebe2719e863017f8b36d
+  data.tar.gz: 35a1096e6ee240aff7b718d6a9a220063cd8b24ed87ee55e90fa6f7fe8467c01f2dfae876efd786c73c20215fa74069a2b44747b97b6a7ab43df9ee3cc8b0157

data/README.md

@@ -35,6 +35,15 @@ puts resultado.area_km2
 puts resultado.codigo_ibge
 ```
 
+####Consultar informações de um estado:
+```ruby
+require 'postmon_ruby'
+resultado = PostmonRuby::Client.search :estado, "SP"
+puts resultado.area_km2
+puts resultado.codigo_ibge
+puts resultado.nome
+```
+
 ## Contributing
 
 1. Fork it

data/bin/postmon-ruby

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require './lib/postmon_ruby'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage postmon [options]"
+  opts.on("--cep CEP", String, "Consultar CEP") do |cep|
+    options[:cep] = cep
+  end
+
+  opts.on("--cidade UF,Cidade", Array, "Consultar informações de uma cidade") do |uf_cidade|
+    options[:cidade] = uf_cidade
+  end
+
+  opts.on("--estado UF", String, "Consultar informações de um estado") do |uf|
+    options[:estado] = uf
+  end
+
+  opts.on("--rastreio CODIGO_POSTAGEM", String, "Consultar informações de rastreio de um pacote") do |rastreio|
+    options[:rastreio] = rastreio
+  end  
+end.parse!
+
+PostmonRuby::GemOutput.get_info(options)

data/lib/postmon_ruby/address.rb

@@ -7,11 +7,11 @@ module PostmonRuby
     def initialize(options={})
       @not_found = true if options.nil?
       @@address_attributes.each do |attribute|
-        send(:"#{attribute}=", options[attribute.to_s] || "") 
+        send(:"#{attribute}=", options[attribute.to_s] || "")
       end
     end
 
     private
     attr_writer *@@address_attributes
   end
-end
+end

data/lib/postmon_ruby/client.rb

@@ -6,4 +6,4 @@ module PostmonRuby
       # PostmonRuby::Finders::Finders.get_finder(finder).search(arguments)
     end
   end
-end
+end

data/lib/postmon_ruby/finders/finders.rb

@@ -3,7 +3,9 @@ module PostmonRuby
     class Finders
       @finders = { 
         cep:    PostmonRuby::Finders::CepFinder.new,
-        cidade: PostmonRuby::Finders::CityFinder.new
+        cidade: PostmonRuby::Finders::CityFinder.new,
+        estado: PostmonRuby::Finders::StateFinder.new,
+        rastreio: PostmonRuby::Finders::TrackerFinder.new
       }
 
       def self.get_finder(finder)

data/lib/postmon_ruby/finders/state_finder.rb

@@ -0,0 +1,18 @@
+module PostmonRuby
+  module Finders
+    class StateFinder < PostmonRuby::Finders::Finder
+      def endpoint
+        "/uf"
+      end
+
+      def arguments_size
+        1
+      end
+
+      def search(*arguments)
+        arguments.flatten!
+        PostmonRuby::State.new( HTTParty.get(self.arguments_uri(arguments)) )
+      end
+    end
+  end
+end

data/lib/postmon_ruby/finders/tracker/ect_tracker_finder.rb

@@ -0,0 +1,20 @@
+module PostmonRuby
+  module Finders
+    module Tracker
+      class ECTTrackerFinder < PostmonRuby::Finders::Finder
+        def endpoint
+          "rastreio/ect"
+        end
+
+        def arguments_size
+          1
+        end
+
+        def search(*arguments)
+          arguments.flatten!
+          PostmonRuby::Track.new( HTTParty.get(self.arguments_uri(arguments)) )
+        end
+      end
+    end
+  end
+end

data/lib/postmon_ruby/finders/tracker_finder.rb

@@ -0,0 +1,18 @@
+module PostmonRuby
+  module Finders
+    class TrackerFinder < PostmonRuby::Finders::Finder
+      @@trackers = {
+        ect: PostmonRuby::Finders::Tracker::ECTTrackerFinder.new
+      }
+      def arguments_size
+        2
+      end
+
+      def search(*arguments)
+        arguments.flatten!
+        @@trackers[arguments.first].search(arguments[1..-1])
+      end
+
+    end
+  end
+end

data/lib/postmon_ruby/gem_output.rb

@@ -0,0 +1,67 @@
+module PostmonRuby
+  class GemOutput
+    def self.get_info(options)
+      unless options[:cep].nil?
+        cep(options[:cep])
+      end
+
+      unless options[:cidade].nil?
+        cidade(options[:cidade].first, options[:cidade].last)
+      end
+
+      unless options[:estado].nil?
+        estado(options[:estado])
+      end
+
+      unless options[:rastreio].nil?
+        rastreio(options[:rastreio])
+      end      
+    end
+
+    private
+    def self.cep(cep)
+      resultado = Client.search :cep, cep
+      output_variables(resultado)
+    end
+
+    def self.cidade(uf, cidade)
+      resultado = Client.search :cidade, uf, cidade
+      output_variables(resultado)
+    end
+
+    def self.estado(uf)
+      resultado = PostmonRuby::Client.search :estado, uf
+      output_variables(resultado)
+    end
+
+    def self.rastreio(rastreio)
+      resultado = PostmonRuby::Client.search :rastreio, :ect, rastreio
+      output_variables(resultado)
+    end    
+
+    def self.output_variables(resultado)
+      if resultado.not_found
+        puts "Nenhum resultado encontrado."
+      else
+        info = {}
+
+        resultado.instance_variables.each do |var|
+          info[var.to_s.delete("@").capitalize] = resultado.instance_variable_get(var)
+        end
+
+        print_array_output(info)
+      end
+    end
+
+    def self.print_array_output(array, level = 0)
+      array.each do |k, v|
+        print "\t" if level > 0
+        if(v.kind_of?(Enumerable) || k.kind_of?(Enumerable))
+          print_array_output(v||k, 1)
+        else
+          puts "#{k}: #{v}"
+        end
+      end      
+    end
+  end
+end

data/lib/postmon_ruby/state.rb

@@ -0,0 +1,17 @@
+module PostmonRuby
+  class State
+    @@state_attributes = [ :area_km2, :codigo_ibge, :nome ]
+
+    attr_reader :not_found, *@@state_attributes
+
+    def initialize(options={})
+      @not_found = true if options.nil?
+      @@state_attributes.each do |attribute|
+        send(:"#{attribute}=", options[attribute.to_s] || "") 
+      end
+    end
+
+    private
+    attr_writer *@@state_attributes
+  end
+end

data/lib/postmon_ruby/track.rb

@@ -0,0 +1,20 @@
+module PostmonRuby
+  class Track
+    #TODO criar um model para salvar o historico do rastreio
+    @@track_attributes = [ :codigo, :servico ]
+
+    attr_reader :not_found, *@@track_attributes
+    attr_reader :historico
+
+    def initialize(options={})
+      @not_found = true if options.nil?
+      @@track_attributes.each do |attribute|
+        send(:"#{attribute}=", options[attribute.to_s] || "") 
+      end
+      @historico = options["historico"] || []
+    end
+
+    private
+    attr_writer *@@track_attributes
+  end
+end

data/lib/postmon_ruby/version.rb

@@ -1,3 +1,3 @@
 module PostmonRuby
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/postmon_ruby.rb

@@ -1,12 +1,17 @@
-require "postmon_ruby/version"
-require "postmon_ruby/client"
-require "postmon_ruby/address"
-require "postmon_ruby/city"
-require "postmon_ruby/finders/finder"
-require "postmon_ruby/finders/cep_finder"
-require "postmon_ruby/finders/city_finder"
-require "postmon_ruby/finders/finders" 
-
+require "./lib/postmon_ruby/version"
+require "./lib/postmon_ruby/client"
+require "./lib/postmon_ruby/city"
+require "./lib/postmon_ruby/state"
+require "./lib/postmon_ruby/address"
+require "./lib/postmon_ruby/gem_output"
+require "./lib/postmon_ruby/track"
+require "./lib/postmon_ruby/finders/finder"
+require "./lib/postmon_ruby/finders/cep_finder"
+require "./lib/postmon_ruby/finders/city_finder"
+require "./lib/postmon_ruby/finders/state_finder"
+require "./lib/postmon_ruby/finders/tracker/ect_tracker_finder"
+require "./lib/postmon_ruby/finders/tracker_finder"
+require "./lib/postmon_ruby/finders/finders" 
 require "httparty"
 
 module PostmonRuby

data/postmon_ruby.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = 'postmon-ruby'
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock", "~> 1.17"
 end

data/spec/postmon_ruby/cep_finder_spec.rb

@@ -47,6 +47,6 @@ module PostmonRuby
         end
 
       end
-    end  
+    end
   end
-end
+end

data/spec/postmon_ruby/ect_tracker_finder_spec.rb

@@ -0,0 +1,62 @@
+require "spec_helper"
+
+module PostmonRuby
+  module Finders
+    module Tracker
+
+      describe ECTTrackerFinder do
+        describe "#search" do
+          context "with too many arguments" do
+            it "raise an ArgumentError" do
+              expect{ PostmonRuby::Client.search(:rastreio, :ect, "TESTE", "1234123") }.to raise_error(ArgumentError)
+            end
+          end
+
+          context "with less arguments" do
+            it "raise an ArgumentError" do
+              expect{ PostmonRuby::Client.search(:rastreio, :ect) }.to raise_error(ArgumentError)
+            end
+          end        
+
+          context "with valid tracking code" do
+            # WebMock.disable_net_connect!
+            let(:track) { 
+              #TODO - stubar a request para retornar um json
+              # stub_request(:any, "api.postmon.com.br/v1/rastreio/ect/TESTE").
+              #   to_return(body: File.new('spec/support/track.json').read.to_json, status: 200, content_type: 'application/json') 
+              # PostmonRuby::Client.search(:rastreio, :ect, "TESTE" ) 
+              PostmonRuby::Client.search(:rastreio, :ect, "PG864394568BR")
+            }
+            it "returns a PostmonRuby::Track object" do
+              expect(track).to be_a(PostmonRuby::Track)
+            end
+            it "returns array in history attribute" do
+              expect(track.historico).to be_a(Array)
+            end
+            it "returns 6 itens in history" do
+              track.historico.should have(6).items
+            end
+            it "returns a complete track info" do
+              expect(track.servico).to eq "ect"
+              expect(track.codigo).to eq "PG864394568BR"
+              expect(track.historico.first["local"]).to eq "CEE VILA NOVA CACHOEIRINHA - SAO PAULO/SP"
+              expect(track.historico.first["situacao"]).to eq "Postado"
+            end
+            # WebMock.allow_net_connect!          
+          end
+   
+          context "with invalid tracking code" do
+            let(:track) { PostmonRuby::Client.search(:rastreio, :ect, "00000000") }
+            it "returns a PostmonRuby::Track object" do
+              expect(track).to be_a(PostmonRuby::Track)
+            end
+            it "returns true in 'not_found'" do
+              expect(track.not_found).to be_true
+            end          
+          end
+
+        end
+      end
+    end  
+  end
+end

data/spec/postmon_ruby/state_finder_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+module PostmonRuby
+  module Finders
+    describe StateFinder do
+      describe "#search" do
+        context "with too many arguments" do
+          it "raise an ArgumentError" do
+            expect{ PostmonRuby::Client.search(:estado, "SP", "xxxxx") }.to raise_error(ArgumentError)
+          end
+        end
+
+        context "with less arguments" do
+          it "raise an ArgumentError" do
+            expect{ PostmonRuby::Client.search(:estado) }.to raise_error(ArgumentError)
+          end
+        end        
+
+        context "with valid state" do
+          let(:state) { PostmonRuby::Client.search(:estado, "SP" ) }
+          it "returns a PostmonRuby::State object" do
+            expect(state).to be_a(PostmonRuby::State)
+          end
+          it "returns a complete state info" do
+            expect(state.area_km2).to eq "248.222,801"
+            expect(state.codigo_ibge).to eq "35"
+            expect(state.nome).to eq "São Paulo"
+          end          
+        end
+ 
+        context "with invalid state" do
+          let(:state) { PostmonRuby::Client.search(:estado, "SK") }
+          it "returns a PostmonRuby::State object" do
+            expect(state).to be_a(PostmonRuby::State)
+          end
+          it "returns true in 'not_found'" do
+            expect(state.not_found).to be_true
+          end          
+        end        
+
+      end
+    end  
+  end
+end

data/spec/spec_helper.rb

@@ -1,10 +1,13 @@
 require "postmon_ruby"
+require "webmock/rspec"
+include WebMock::API
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # Require this file using `require "spec_helper"` to ensure that it is only
 # loaded once.
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+WebMock.allow_net_connect!
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postmon_ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Carlos Ribeiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -80,10 +80,25 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.17'
 description: A rubygem to access the Postmon API
 email:
 - mail@carlosribeiro.me
-executables: []
+executables:
+- postmon-ruby
 extensions: []
 extra_rdoc_files: []
 files:
@@ -93,6 +108,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/postmon-ruby
 - lib/postmon_ruby.rb
 - lib/postmon_ruby/address.rb
 - lib/postmon_ruby/city.rb
@@ -101,11 +117,19 @@ files:
 - lib/postmon_ruby/finders/city_finder.rb
 - lib/postmon_ruby/finders/finder.rb
 - lib/postmon_ruby/finders/finders.rb
+- lib/postmon_ruby/finders/state_finder.rb
+- lib/postmon_ruby/finders/tracker/ect_tracker_finder.rb
+- lib/postmon_ruby/finders/tracker_finder.rb
+- lib/postmon_ruby/gem_output.rb
+- lib/postmon_ruby/state.rb
+- lib/postmon_ruby/track.rb
 - lib/postmon_ruby/version.rb
 - postmon_ruby.gemspec
 - spec/postmon_ruby/cep_finder_spec.rb
 - spec/postmon_ruby/city_finder_spec.rb
 - spec/postmon_ruby/client_spec.rb
+- spec/postmon_ruby/ect_tracker_finder_spec.rb
+- spec/postmon_ruby/state_finder_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/PostmonAPI/postmon-ruby
 licenses:
@@ -135,4 +159,6 @@ test_files:
 - spec/postmon_ruby/cep_finder_spec.rb
 - spec/postmon_ruby/city_finder_spec.rb
 - spec/postmon_ruby/client_spec.rb
+- spec/postmon_ruby/ect_tracker_finder_spec.rb
+- spec/postmon_ruby/state_finder_spec.rb
 - spec/spec_helper.rb