Chore: Change code samples following the Runkit pattern

Author: lnfnunes

README.md

@@ -48,9 +48,9 @@ Teste e aprenda <a href="https://npm.runkit.com/cep-promise" target="_blank">aqu
 Por ser multifornecedor, a biblioteca irá resolver a Promise com o fornecedor que **mais rápido** lhe responder.
 
 ``` js
-import cep from 'cep-promise'
+import cepPromise from 'cep-promise'
 
-cep('05010000')
+cepPromise('05010000')
   .then(console.log)
 
   // {
@@ -68,10 +68,10 @@ cep('05010000')
 Em muitos sistemas o CEP é utilizado erroneamente como um Inteiro (e com isto cortando todos os zeros à esquerda). Caso este seja o seu caso, não há problema, pois a biblioteca irá preencher os caracteres faltantes na String, por exemplo:
 
 ``` js
-import cep from 'cep-promise'
+import cepPromise from 'cep-promise'
 
 // enviando sem ter um zero à esquerda do CEP "05010000"
-cep(5010000)
+cepPromise(5010000)
   .then(console.log)
 
   // {
@@ -88,9 +88,9 @@ cep(5010000)
 Neste caso será retornado um `"service_error"` e por ser multifornecedor, a biblioteca irá rejeitar a Promise apenas quando tiver a resposta negativa de todos os fornecedores.
 
 ``` js
-import cep from 'cep-promise'
+import cepPromise from 'cep-promise'
 
-cep('99999999')
+cepPromise('99999999')
   .catch(console.log)
 
   // {
@@ -116,9 +116,9 @@ cep('99999999')
 Neste caso será retornado um `"validation_error"` e a biblioteca irá rejeitar imediatamente a Promise, sem chegar a consultar nenhum fornecedor.
 
 ``` js
-import cep from 'cep-promise'
+import cepPromise from 'cep-promise'
 
-cep('123456789123456789')
+cepPromise('123456789123456789')
   .catch(console.log)
 
   // {
@@ -157,7 +157,7 @@ $ bower install --save cep-promise
 ``` ts
 import * as cep from 'cep-promise'
 
-cep('05010000')
+cepPromise('05010000')
   .then(console.log)
 ```
 

package.json

@@ -34,7 +34,8 @@
     "zipcode",
     "zip",
     "promise",
-    "viacep"
+    "viacep",
+    "cepPromise"
   ],
   "homepage": "https://github.com/filipedeschamps/cep-promise",
   "devDependencies": {

test/e2e/cep-promise.spec.js

@@ -4,7 +4,7 @@ import chai from 'chai'
 import chaiAsPromised from 'chai-as-promised'
 import chaiSubset from 'chai-subset'
 
-import cep from '../../src/cep-promise.js'
+import cepPromise from '../../src/cep-promise.js'
 import CepPromiseError from '../../src/errors/cep-promise.js'
 
 chai.use(chaiAsPromised)
@@ -15,7 +15,7 @@ let expect = chai.expect
 describe('cep-promise (E2E)', () => {
   describe('when invoked with a valid "05010000" string', () => {
     it('should fulfill with correct address', () => {
-      return expect(cep('05010000')).to.eventually.deep.equal({
+      return expect(cepPromise('05010000')).to.eventually.deep.equal({
         cep: '05010000',
         state: 'SP',
         city: 'São Paulo',
@@ -27,7 +27,7 @@ describe('cep-promise (E2E)', () => {
 
   describe('when invoked with a valid 5010000 number', () => {
     it('should fulfill with correct address', () => {
-      return expect(cep(5010000)).to.eventually.deep.equal({
+      return expect(cepPromise(5010000)).to.eventually.deep.equal({
         cep: '05010000',
         state: 'SP',
         city: 'São Paulo',
@@ -39,7 +39,7 @@ describe('cep-promise (E2E)', () => {
 
   describe('when invoked with an inexistent "99999999" CEP', () => {
     it('should reject with "service_error"', () => {
-      return cep('99999999')
+      return cepPromise('99999999')
         .catch((error) => {
           return expect(error)
             .to.be.an.instanceOf(CepPromiseError)
@@ -61,7 +61,7 @@ describe('cep-promise (E2E)', () => {
 
   describe('when invoked with an invalid "123456789" CEP', () => {
     it('should reject with "validation_error"', () => {
-      return cep('123456789')
+      return cepPromise('123456789')
         .catch((error) => {
           return expect(error)
             .to.be.an.instanceOf(CepPromiseError)

test/unit/cep-promise.spec.js

@@ -6,7 +6,7 @@ import chaiSubset from 'chai-subset'
 import nock from 'nock'
 import path from 'path'
 
-import cep from '../../src/cep-promise.js'
+import cepPromise from '../../src/cep-promise.js'
 import CepPromiseError from '../../src/errors/cep-promise.js'
 
 chai.use(chaiAsPromised)
@@ -17,7 +17,7 @@ let expect = chai.expect
 describe('cep-promise (unit)', () => {
   describe('when imported', () => {
     it('should return a Function', () => {
-      expect(cep).to.be.a('function')
+      expect(cepPromise).to.be.a('function')
     })
   })
 
@@ -33,15 +33,15 @@ describe('cep-promise (unit)', () => {
         .get('/api/v2/ceps.json?cep=05010000')
         .replyWithFile(200, path.join(__dirname, '/fixtures/cep-aberto-05010000-found.json'))
 
-      const cepPromise = cep('05010000')
+      const cepPromise = cepPromise('05010000')
       expect(cepPromise.then).to.be.a('function')
       expect(cepPromise.catch).to.be.a('function')
     })
   })
 
   describe('when invoked without arguments', () => {
     it('should reject with "validation_error"', () => {
-      return cep()
+      return cepPromise()
         .catch((error) => {
           return expect(error)
             .to.be.an.instanceOf(CepPromiseError)
@@ -60,7 +60,7 @@ describe('cep-promise (unit)', () => {
 
   describe('when invoked with an Array', () => {
     it('should reject with "validation_error"', () => {
-      return cep([1, 2, 3])
+      return cepPromise([1, 2, 3])
         .catch((error) => {
           return expect(error)
             .to.be.an.instanceOf(CepPromiseError)
@@ -79,7 +79,7 @@ describe('cep-promise (unit)', () => {
 
   describe('when invoked with an Object', () => {
     it('should reject with "validation_error"', () => {
-      return cep({ nintendo: true, ps: false, xbox: false })
+      return cepPromise({ nintendo: true, ps: false, xbox: false })
         .catch((error) => {
           return expect(error)
             .to.be.an.instanceOf(CepPromiseError)
@@ -98,7 +98,7 @@ describe('cep-promise (unit)', () => {
 
   describe('when invoked with an Function', () => {
     it('should reject with "validation_error"', () => {
-      return cep(function zelda () { return 'link' })
+      return cepPromise(function zelda () { return 'link' })
         .catch((error) => {
           return expect(error)
             .to.be.an.instanceOf(CepPromiseError)
@@ -128,7 +128,7 @@ describe('cep-promise (unit)', () => {
         .get('/api/v2/ceps.json?cep=05010000')
         .replyWithFile(200, path.join(__dirname, '/fixtures/cep-aberto-05010000-found.json'))
 
-      return expect(cep('05010000')).to.eventually.deep.equal({
+      return expect(cepPromise('05010000')).to.eventually.deep.equal({
         cep: '05010000',
         state: 'SP',
         city: 'São Paulo',
@@ -150,7 +150,7 @@ describe('cep-promise (unit)', () => {
         .get('/api/v2/ceps.json?cep=05010000')
         .replyWithFile(200, path.join(__dirname, '/fixtures/cep-aberto-05010000-found.json'))
 
-      return expect(cep(5010000)).to.eventually.deep.equal({
+      return expect(cepPromise(5010000)).to.eventually.deep.equal({
         cep: '05010000',
         state: 'SP',
         city: 'São Paulo',
@@ -172,7 +172,7 @@ describe('cep-promise (unit)', () => {
         .get('/api/v2/ceps.json?cep=05010000')
         .replyWithFile(200, path.join(__dirname, '/fixtures/cep-aberto-99999999-error.json'))
 
-      return expect(cep('5010000')).to.eventually.deep.equal({
+      return expect(cepPromise('5010000')).to.eventually.deep.equal({
         cep: '05010000',
         state: 'SP',
         city: 'São Paulo',
@@ -193,8 +193,8 @@ describe('cep-promise (unit)', () => {
       nock('http://www.cepaberto.com')
         .get('/api/v2/ceps.json?cep=05010000')
         .replyWithFile(200, path.join(__dirname, '/fixtures/cep-aberto-99999999-error.json'))
-        
-      return expect(cep('5010000')).to.eventually.deep.equal({
+
+      return expect(cepPromise('5010000')).to.eventually.deep.equal({
         cep: '05010000',
         state: 'SP',
         city: 'São Paulo',
@@ -215,8 +215,8 @@ describe('cep-promise (unit)', () => {
       nock('http://www.cepaberto.com')
         .get('/api/v2/ceps.json?cep=05010000')
         .replyWithFile(200, path.join(__dirname, '/fixtures/cep-aberto-05010000-found.json'))
-        
-      return expect(cep('5010000')).to.eventually.deep.equal({
+
+      return expect(cepPromise('5010000')).to.eventually.deep.equal({
         cep: '05010000',
         state: 'SP',
         city: 'São Paulo',
@@ -238,7 +238,7 @@ describe('cep-promise (unit)', () => {
         .get('/api/v2/ceps.json?cep=05010000')
         .replyWithFile(200, path.join(__dirname, '/fixtures/cep-aberto-05010000-found.json'))
 
-      return expect(cep('5010000')).to.eventually.deep.equal({
+      return expect(cepPromise('5010000')).to.eventually.deep.equal({
         cep: '05010000',
         state: 'SP',
         city: 'São Paulo',
@@ -260,7 +260,7 @@ describe('cep-promise (unit)', () => {
         .get('/api/v2/ceps.json?cep=05010000')
         .replyWithFile(200, path.join(__dirname, '/fixtures/cep-aberto-05010000-found.json'))
 
-      return expect(cep('5010000')).to.eventually.deep.equal({
+      return expect(cepPromise('5010000')).to.eventually.deep.equal({
         cep: '05010000',
         state: 'SP',
         city: 'São Paulo',
@@ -282,7 +282,7 @@ describe('cep-promise (unit)', () => {
         .get('/api/v2/ceps.json?cep=99999999')
         .replyWithFile(200, path.join(__dirname, '/fixtures/cep-aberto-99999999-error.json'))
 
-      return cep('99999999')
+      return cepPromise('99999999')
         .catch((error) => {
           return expect(error)
             .to.be.an.instanceOf(CepPromiseError)
@@ -307,7 +307,7 @@ describe('cep-promise (unit)', () => {
 
   describe('when invoked with an invalid "123456789" CEP', () => {
     it('should reject with "validation_error"', () => {
-      return cep('123456789')
+      return cepPromise('123456789')
         .catch((error) => {
           return expect(error)
             .to.be.an.instanceOf(CepPromiseError)
@@ -336,7 +336,7 @@ describe('cep-promise (unit)', () => {
         .get('/api/v2/ceps.json?cep=05010000')
         .reply(400, '<h2>Bad Request (400)</h2>')
 
-      return cep('05010000')
+      return cepPromise('05010000')
         .catch((error) => {
           return expect(error)
             .to.be.an.instanceOf(CepPromiseError)
@@ -371,7 +371,7 @@ describe('cep-promise (unit)', () => {
         .get('/api/v2/ceps.json?cep=05010000')
         .reply(400, '<h2>Bad Request (400)</h2>')
 
-      return cep('05010000')
+      return cepPromise('05010000')
         .catch((error) => {
           return expect(error)
             .to.be.an.instanceOf(CepPromiseError)
@@ -406,7 +406,7 @@ describe('cep-promise (unit)', () => {
         .get('/api/v2/ceps.json?cep=05010000')
         .replyWithError('getaddrinfo ENOTFOUND apps.correios.com.br apps.correios.com.br:443')
 
-      return cep('05010000')
+      return cepPromise('05010000')
         .catch((error) => {
           return expect(error)
             .to.be.an.instanceOf(CepPromiseError)