README.md in sigiss-0.1.0 vs README.md in sigiss-0.1.1
- old
+ new
@@ -1,41 +1,138 @@
# Sigiss
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sigiss`. To experiment with that code, run `bin/console` for an interactive prompt.
+[](https://travis-ci.org/gabrielpedepera/sigiss) [](https://codeclimate.com/github/gabrielpedepera/sigiss) [](https://codeclimate.com/github/gabrielpedepera/sigiss/coverage)
-TODO: Delete this and the text above, and describe your gem
+Ruby gem para integração com o WebService para NFS-e do SIGISS.
-## Installation
+Atualmente suportando as seguintes cidades:
-Add this line to your application's Gemfile:
+ - Bauru - SP
+ - Botucatu - SP
+ - Marília - SP
+ - Londrina - SP
+ - Rio Grande - RS
+Obs.: A gem foi desenvolvida baseada no WebService de [Marília-SP](https://marilia.sigiss.com.br/marilia/ws/sigiss_ws.php) e [Manual]( http://www.bauru.sp.gov.br/arquivos/arquivos_site/sec_financas/nfse_manual_webservice.pdf).
+Caso exista divergências na integrações com outras cidades ou a gem contemple outras para integração,
+seu PR ou sua informação será muito bem vinda para atualização.
+
+## Instalação
+
+Adicionar ao Gemfile:
+
```ruby
gem 'sigiss'
```
-And then execute:
+Executar:
$ bundle
-Or install it yourself as:
+Ou instalar como:
$ gem install sigiss
-## Usage
+## Uso
-TODO: Write usage instructions here
+#### Definir a cidade (gateway) para emissão da Nota Fiscal:
-## Development
+```ruby
+gateway = Sigiss::Gateway.new(:marilia, :test) # Ambiente de teste
+gateway = Sigiss::Gateway.new(:marilia, :production) # Ambiente de Produção
+```
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+#### Definir os dados referente ao prestador:
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+params = {
+ ccm: '31000',
+ cnpj: '90082563000169',
+ senha: '12345',
+ crc: '',
+ crc_estado: ''
+}
+```
-## Contributing
+```ruby
+provider = Sigiss::Provider.new(params)
+```
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sigiss.
+#### Definir os dados referente ao tomador:
+```ruby
+params = {
+ tomador_tipo: '2',
+ tomador_cnpj: '08600061822',
+ tomador_email: 'email@tomador.com',
+ tomador_im: '',
+ tomador_ie: '',
+ tomador_razao: 'Pagador de Impostos',
+ tomador_fantasia: '',
+ tomador_endereco: 'Rua de Asfalto',
+ tomador_numero: '100',
+ tomador_complemento: 'Fundos',
+ tomador_bairro: 'Bairro Feliz',
+ tomador_CEP: '17512752',
+ tomador_cod_cidade: '3127107',
+ tomador_fone: '1499998888',
+ tomador_ramal: '',
+ tomador_fax: '',
+ tomador_ramal_fax: ''
+}
+```
-## License
+```ruby
+taker = Sigiss::Taker.new(params)
+```
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+### APIs
+#### Emissão
+```ruby
+invoice = Sigiss::Invoice.new(gateway: gateway, provider: provider, taker: taker)
+params = {
+ aliquota_simples: '',
+ id_sis_legado: '',
+ servico: '105',
+ situacao: 'tp',
+ valor: '10,00',
+ base: '10,00',
+ descricaoNF: 'Teste NF'
+}
+invoice.build(issue: params)
+invoice.issue!
+```
+
+#### Consulta
+```ruby
+invoice = Sigiss::Invoice.new(gateway: gateway, provider: provider)
+params = {
+ nota: '13114',
+ serie: '1',
+ autenticidade: '2ZZGUTL0',
+ valor: '10,00'
+}
+invoice.build(fetch: params)
+invoice.fetch!
+```
+
+#### Cancelamento
+```ruby
+invoice = Sigiss::Invoice.new(gateway: gateway, provider: provider)
+params = {
+ nota: '13114',
+ motivo: 'Falha no Engano',
+ email: 'email@tomador.com'
+}
+invoice.build(cancel: params)
+invoice.cancel!
+```
+
+## Contribuição
+
+Reportar bugs e Pull Requests são bem vindos no Github em https://github.com/gabrielpedepera/sigiss.
+
+
+## Licença
+
+A gem está disponível como open source sobre os termos de [MIT License](http://opensource.org/licenses/MIT).