postmon_ruby 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8c7637a9ac46b5a46c1280fcce2f3d15c7b5c86
-  data.tar.gz: 53170191a0f5b7e959cd1b406af6078fad76e267
+  metadata.gz: ff5b09bd792c1b13f2df53c3a5e500c06ca3eff9
+  data.tar.gz: 8e6400cf6705e415d68e1fe5b958e670d5ab7240
 SHA512:
-  metadata.gz: e2ea3624232f381a8245f958d2b0c108adddb48fd11ef35617a9897a80ecdc385658c8c178578f410618a8d5a015858bb9995f10b45ea514194207813b6a615e
-  data.tar.gz: a5a74175238cff9df2900171b3993df91fcac1ae069cb67129df1524d9216e49360b14bdbcf0c1ed69baadd334b1ce3bdbd1c79262de88b395049397fe4bf8ac
+  metadata.gz: 693631c654886c4595a88e8d685ba24e05a63a0a7b691d4c90e209cbab147b7b13cac951ef3a75a2e22b9fdb412e5feddccf04e9416436dd347d9f1a430f7eff
+  data.tar.gz: bdcb4c8e14479ff2985dc0ec37fcfdee0e4d4d8b8d9546c23f83467facdc35e902b840ed25aa34ac76eb2e1122788912a52e57bf0ad4a33acb4c3d2bd35ac97a

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format progress
+--format documentation

data/README.md

@@ -17,16 +17,24 @@ Or install it yourself as:
     $ gem install postmon_ruby
 
 ## Usage
-
+####Consultar CEP:
 ```ruby
 require 'postmon_ruby'
-resultado = PostmonRuby::Client.search "01330000"
+resultado = PostmonRuby::Client.search :cep, "01330000"
 puts resultado.logradouro
 puts resultado.bairro
 puts resultado.cidade
 puts resultado.estado
 ```
 
+####Consultar informações de uma cidade:
+```ruby
+require 'postmon_ruby'
+resultado = PostmonRuby::Client.search :cidade, "SP", "Araraquara"
+puts resultado.area_km2
+puts resultado.codigo_ibge
+```
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :console do
+  exec "irb -I ./lib -r postmon_ruby"
+end
+

data/lib/postmon_ruby.rb

@@ -1,8 +1,14 @@
 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 "httparty"
 
 module PostmonRuby
-  ENDPOINT = "http://api.postmon.com.br"
+  ENDPOINT = "http://api.postmon.com.br/v1"
 end

data/lib/postmon_ruby/city.rb

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

data/lib/postmon_ruby/client.rb

@@ -1,7 +1,9 @@
 module PostmonRuby
   class Client
-    def self.search(cep)
-      PostmonRuby::Address.new( HTTParty.get("#{ENDPOINT}/cep/#{cep}") )
+    def self.search(finder, *arguments)
+      arguments.flatten!
+      PostmonRuby::Finders::Finder.new.search(finder, arguments)
+      # PostmonRuby::Finders::Finders.get_finder(finder).search(arguments)
     end
   end
 end

data/lib/postmon_ruby/finders/cep_finder.rb

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

data/lib/postmon_ruby/finders/city_finder.rb

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

data/lib/postmon_ruby/finders/finder.rb

@@ -0,0 +1,24 @@
+module PostmonRuby
+  module Finders
+    class Finder
+      def endpoint
+        raise NotImplementedError
+      end
+
+      def arguments_size
+        raise NotImplementedError
+      end      
+
+      def search(finder, *arguments)
+        arguments.flatten!
+        finder = PostmonRuby::Finders::Finders.get_finder(finder)
+        raise ArgumentError.new("wrong number of arguments (#{arguments.size} for #{finder.arguments_size})") if finder.arguments_size != arguments.size
+        finder.search(arguments)
+      end
+
+      def arguments_uri(arguments)
+        URI::encode("#{ENDPOINT}/#{self.endpoint}/#{arguments.join("/")}")
+      end
+    end
+  end
+end

data/lib/postmon_ruby/finders/finders.rb

@@ -0,0 +1,15 @@
+module PostmonRuby
+  module Finders
+    class Finders
+      @finders = { 
+        cep:    PostmonRuby::Finders::CepFinder.new,
+        cidade: PostmonRuby::Finders::CityFinder.new
+      }
+
+      def self.get_finder(finder)
+        @finders[finder.to_sym]
+      end
+        
+    end
+  end
+end

data/lib/postmon_ruby/version.rb

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

data/spec/postmon_ruby/cep_finder_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+module PostmonRuby
+  module Finders
+    describe CepFinder do
+      describe "#search" do
+        context "with too many arguments" do
+          it "raise an ArgumentError" do
+            expect{ PostmonRuby::Client.search(:cep, "01330000", "xxxx") }.to raise_error(ArgumentError)
+          end
+        end
+
+        context "with valid cep" do
+          context "address with street" do
+            let(:address) { PostmonRuby::Client.search(:cep, "01330000") }
+            it "returns a PostmonRuby::Address object" do
+              expect(address).to be_a(PostmonRuby::Address)
+            end
+            it "returns a complete address" do
+              expect(address.bairro).to eq "Bela Vista"
+              expect(address.cidade).to eq "São Paulo"
+              expect(address.logradouro).to eq "Rua Rocha"
+              expect(address.estado).to eq "SP"
+            end
+          end
+
+          context "address without street" do
+            let(:address) { PostmonRuby::Client.search(:cep, "85100000") }
+            it "returns a PostmonRuby::Address object" do
+              expect(address).to be_a(PostmonRuby::Address)
+            end
+            it "returns a empty 'logradouro' " do
+              expect(address.logradouro).to be_empty
+            end
+          end
+        end
+
+        context "with invalid cep" do
+          let(:address) { PostmonRuby::Client.search(:cep, "99999999") }
+          it "returns a PostmonRuby::Address object" do
+            expect(address).to be_a(PostmonRuby::Address)
+          end
+
+          it "returns true in 'not_found'" do
+            expect(address.not_found).to be_true
+          end
+        end
+
+      end
+    end  
+  end
+end

data/spec/postmon_ruby/city_finder_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+module PostmonRuby
+  module Finders
+    describe CityFinder do
+      describe "#search" do
+        context "with too many arguments" do
+          it "raise an ArgumentError" do
+            expect{ PostmonRuby::Client.search(:cidade, "SP", "Araraquara", "xxxxx") }.to raise_error(ArgumentError)
+          end
+        end
+
+        context "with less arguments" do
+          it "raise an ArgumentError" do
+            expect{ PostmonRuby::Client.search(:cidade, "SP") }.to raise_error(ArgumentError)
+          end
+        end        
+
+        context "with valid city" do
+          let(:city) { PostmonRuby::Client.search(:cidade, "SP", "Araraquara") }
+          it "returns a PostmonRuby::City object" do
+            expect(city).to be_a(PostmonRuby::City)
+          end
+          it "returns a complete city info" do
+            expect(city.area_km2).to eq "1003,674"
+            expect(city.codigo_ibge).to eq "3503208"
+          end          
+        end
+
+        context "with valid city with special characters" do
+          let(:city) { PostmonRuby::Client.search(:cidade, "SP", "São Paulo") }
+          it "returns a PostmonRuby::City object" do
+            expect(city).to be_a(PostmonRuby::City)
+          end
+          it "returns a complete city info" do
+            expect(city.area_km2).to eq "1521,101"
+            expect(city.codigo_ibge).to eq "3550308"
+          end          
+        end        
+
+        context "with invalid city" do
+          let(:city) { PostmonRuby::Client.search(:cidade, "SP", "Xxxx") }
+          it "returns a PostmonRuby::City object" do
+            expect(city).to be_a(PostmonRuby::City)
+          end
+          it "returns true in 'not_found'" do
+            expect(city.not_found).to be_true
+          end          
+        end        
+
+      end
+    end  
+  end
+end

data/spec/postmon_ruby/client_spec.rb

@@ -0,0 +1,6 @@
+require "spec_helper"
+
+module PostmonRuby
+  describe Client do
+  end  
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postmon_ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Carlos Ribeiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-20 00:00:00.000000000 Z
+date: 2014-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -95,10 +95,17 @@ files:
 - Rakefile
 - lib/postmon_ruby.rb
 - lib/postmon_ruby/address.rb
+- lib/postmon_ruby/city.rb
 - lib/postmon_ruby/client.rb
+- lib/postmon_ruby/finders/cep_finder.rb
+- lib/postmon_ruby/finders/city_finder.rb
+- lib/postmon_ruby/finders/finder.rb
+- lib/postmon_ruby/finders/finders.rb
 - lib/postmon_ruby/version.rb
 - postmon_ruby.gemspec
-- spec/postmon_ruby/postmon_ruby_spec.rb
+- spec/postmon_ruby/cep_finder_spec.rb
+- spec/postmon_ruby/city_finder_spec.rb
+- spec/postmon_ruby/client_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/PostmonAPI/postmon-ruby
 licenses:
@@ -125,5 +132,7 @@ signing_key:
 specification_version: 4
 summary: A rubygem to access the Postmon API
 test_files:
-- spec/postmon_ruby/postmon_ruby_spec.rb
+- spec/postmon_ruby/cep_finder_spec.rb
+- spec/postmon_ruby/city_finder_spec.rb
+- spec/postmon_ruby/client_spec.rb
 - spec/spec_helper.rb

data/spec/postmon_ruby/postmon_ruby_spec.rb

@@ -1,45 +0,0 @@
-require "spec_helper"
-
-module PostmonRuby
-  describe Client do
-    describe "#find" do
-      context "with valid cep" do
-        context "address with street" do
-          let(:address) { PostmonRuby::Client.search("01330000") }
-          it "returns a PostmonRuby::Address object" do
-            expect(address).to be_a(PostmonRuby::Address)
-          end
-          it "returns a complete address" do
-            expect(address.bairro).to eq "Bela Vista"
-            expect(address.cidade).to eq "São Paulo"
-            expect(address.logradouro).to eq "Rua Rocha"
-            expect(address.estado).to eq "SP"
-          end
-        end
-
-        context "address without street" do
-          let(:address) { PostmonRuby::Client.search("85100000") }
-          it "returns a PostmonRuby::Address object" do
-            # binding.pry
-            expect(address).to be_a(PostmonRuby::Address)
-          end
-          it "returns a empty 'logradouro' " do
-            expect(address.logradouro).to be_empty
-          end
-        end
-      end
-
-      context "with invalid cep" do
-        let(:address) { PostmonRuby::Client.search("99999999") }
-        it "returns a PostmonRuby::Address object" do
-          expect(address).to be_a(PostmonRuby::Address)
-        end
-
-        it "returns true in 'not_found'" do
-          expect(address.not_found).to be_true
-        end
-      end
-
-    end
-  end  
-end