millennium 0.0.2 → 0.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -37
  3. data/lib/millennium/version.rb +1 -1
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: a0dd796da2ce934047e2772866722cf5c63b032f
4
- data.tar.gz: aa51fb2d2dc3b8375fdb2106219108b162467e48
3
+ metadata.gz: 5f2d5dc760da4e924e4cce9e9bb1df20913dba2d
4
+ data.tar.gz: 5b7374c4ec41549d9b232ae5c5dba6c4db0e2e49
5
5
  SHA512:
6
- metadata.gz: 5044a1520942ba76b8dd518518d27ea0d79cae79b9d77cb1d94db462e205ef72f7f14139cdbe356c8cdf9cb1a9de0c9ef8de89b9d1e415c9436f587d08c23759
7
- data.tar.gz: 6ab9638b1b4a672f67d2fc5d6b1ce287d04bb030d46401310a5cd98ed5f07c1f1948e76585c61bf2ed4d2d2e3efb881994392f9509fdc31e6716f82f5aa430e2
6
+ metadata.gz: 72dcdcb3e73aef7830a620c6be51e631f91f3b44c4279cfe50337e734aeac9c10a68782c84e08b86326a31d68012cdee5b2d1404165556698c5974d19fe4a2f0
7
+ data.tar.gz: 85d4afcfadb8a99eaeb0499d518ed09e900e153bedf03c6000366adee440d1035511bd5b39673f6fa819c7943487724e4f34ad46f21bd3d68a191b96ea82159d
data/README.md CHANGED
@@ -1,65 +1,59 @@
1
1
  # Millennium Ruby
2
2
 
3
- Essa gem foi feita para de facilitar a integração com ERP Millennium ECO
4
- API 2.0.
3
+ Esta gem (não oficial) é uma interface para de facilitar a integração com ERP Millennium ECO API 2.0.
5
4
 
6
- No momento esta gem não cobre 100% dos enpoints disponibilizados
7
- pela Millennium.
5
+ ## Documentação
6
+
7
+ Você encontra a documentação da Millennium está nesse [link](http://millennium.iwise.com.br:888/api/millenium_eco/$help). Os dados de acesso são:
8
+
9
+ ```
10
+ Login: OData
11
+ Senha: 0d@t@123
12
+ ```
8
13
 
9
14
  ## Como usar
10
15
 
16
+ > Essa gem foi 100% baseada nos dados disponibilizados pela documentação da Millennium. As únicas coisas que foram alteradas da documentação original foram os padrões de nomenclatura das classes e métodos para o modelo mais adequado para Ruby, porém, foi mantido todos os nomes de classes e métodos em português assim como os dados contidos na documentação da Millennium.
17
+
11
18
  Instale a gem:
12
19
 
13
20
  ```bash
14
21
  gem install millennium
15
22
  ```
16
23
 
17
- Insira as configurações básicas para você poder utilizar os recursos
18
- da API
24
+ Agora insira as configurações básicas para você poder utilizar os recursos da API (utilizaremos os dados de exemplo da própria Millennium):
19
25
 
20
26
  ```ruby
21
27
  require 'millennium'
22
28
 
23
29
  Millennium.configure do |config|
24
- config.user = <%= ENV["MILLENNIUM_USER"] %>
25
- config.pass = <%= ENV["MILLENNIUM_PASS"] %>
26
- config.host = <%= ENV["MILLENNIUM_HOST"] %>
27
- config.port = <%= ENV["MILLENNIUM_PORT"] %>
30
+ config.user = 'OData'
31
+ config.pass = '0d@t@123'
32
+ config.host = 'millennium.iwise.com.br'
33
+ config.port = 888
28
34
  end
29
35
  ```
30
36
 
31
- ### Exemplo: Como obter informações de compras faturadas
37
+ ### Buscando uma compra faturada
32
38
 
33
39
  **Parâmetros**
34
40
 
35
- | Parâmetro | Obrigatório | Tipo | Default | Descrição |
36
- | ------------------------ | :---------: | :--------------------------------: | :-----: | -------------------------------- |
37
- | data_atualizacao | Não | String (formato: YYYY-mm-dd-H-M-S) | - | Data inicial do período desejado |
38
- | vitrine | Não | Integer | - | Data final do período desejado |
39
- | saida_inicial | Não | Integer | - | Data final do período desejado |
40
- | trans_id | Não | Integer | - | Data final do período desejado |
41
- | aprovado | Não | Boolean | - | Data final do período desejado |
42
- | cancelada | Não | Boolean | - | Data final do período desejado |
43
- | data_atualizacao_inicial | Não | String (formato: YYYY-mm-dd-H-M-S) | - | Data final do período desejado |
44
- | data_atualizacao_final | Não | String (formato: YYYY-mm-dd-H-M-S) | - | Data final do período desejado |
41
+ | Parâmetro | Obrigatório | Tipo | Descrição |
42
+ | ------------------------ | :---------: | :--------------------------------: | ---------------------------------- |
43
+ | data_atualizacao | Não | String (formato: YYYY-mm-dd-H-M-S) | Data de atualização |
44
+ | vitrine | Não | Integer | Id da vitrine |
45
+ | saida_inicial | Não | Integer | Id da saida ou entrada que será usado como ponto de partida |
46
+ | trans_id | Não | Integer | Trans_id para a listagem das notas fiscais, as notas fiscais serão listadas a partir desse trans_id. Trans_id é um campo numérico que indica quando um item foi alterado |
47
+ | aprovado | Não | Boolean | Listar somente notas aprovadas |
48
+ | cancelada | Não | Boolean | Listar somente as notas canceladas |
49
+ | data_atualizacao_inicial | Não | String (formato: YYYY-mm-dd-H-M-S) | Data inicial do período desejado |
50
+ | data_atualizacao_final | Não | String (formato: YYYY-mm-dd-H-M-S) | Data final do período desejado |
45
51
 
52
+ **Exemplo:**
46
53
 
47
54
  ```ruby
48
- lista_faturamentos = Millennium::PedidoVenda.lista_faturamentos({
49
- data_atualizacao_inicial: '2016-10-26-17-24-50',
50
- data_atualizacao_final: '2016-10-26-17-24-50',
51
- data_atualizacao: '2016-10-26-17-24-50',
52
- saida_inicial: 55,
53
- cancelada: false,
54
- aprovado: false,
55
- trans_id: 66,
56
- vitrine: 82
55
+ clientes = Millennium::PedidoVenda.lista_faturamentos({
56
+ data_atualizacao_inicial: '2016-01-01-00-00-00',
57
+ data_atualizacao_final: '2016-10-26-23-59-59',
57
58
  })
58
-
59
- lista_faturamentos.status
60
- => "OK"
61
-
62
- lista_faturamentos.body
63
- => "{\"odata.metadata\":\"http:\\/\\/millennium.iwise.com.br:888\\/api\\/millenium_eco\\/$metadata#millenium_eco.MILLENIUM_ECO_PEDIDO_VENDA_LISTAFATURAMENTOS\"
64
- ,\"odata.count\":0,\"value\":[]}"
65
59
  ```
@@ -1,4 +1,4 @@
1
1
  # lib/millennium/version.rb
2
2
  module Millennium
3
- VERSION = '0.0.2'.freeze
3
+ VERSION = '0.0.3'.freeze
4
4
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: millennium
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.2
4
+ version: 0.0.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Paulo Henrique Bruce
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2016-10-27 00:00:00.000000000 Z
11
+ date: 2016-10-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus