apibanca-client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a05aac810bc32fe182122fb2cd8ef1961d683928
-  data.tar.gz: f2775c0ade0e6ec278975bcd0cc5cab7cc05dcf4
+  metadata.gz: a11196cbf7114b0d8f73ee499966ccce88bbac70
+  data.tar.gz: 83c6061b12ba78d65e0092010f2460183f7d7867
 SHA512:
-  metadata.gz: 4235bcaabe647464ebfe812462eb381b3a0fefcc63426193a48609fb82b8d92520c466bdfa88f50e8ed18f7abfec1c5947a29ad9e6048ed9600bccd372880596
-  data.tar.gz: fc953a05aeae0d3f9cd95451bcce25f5d4e77909093375a26578e92b5c81b40a97c17e28d9b993b50b834672773a7efae438539f6f53c48565c602d0a5567681
+  metadata.gz: c332c62906ff60196c88eef8b4ac11461b854ca01871496622b8cbdc61e7019a01065a7bbea834f508cf0142d90a46481cfb01e4a62bdfc240fdc46a0afeea23
+  data.tar.gz: 814cbbb7f4399a44a358cb918c94b479255eb1942a8e2e5a046f09fed324152ecfcaf565428edf2f627d95e11309ec26fad27cb7c20e39b30926387403292b1a

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Bitácora de cambios
 
+## 0.0.3
+
+### Eliminación de rutinas
+Para eliminar una rutina se debe invocar el método `delete` en ella.
+
 ## 0.0.2
 
 ### Configuración del cliente

data/README.md

@@ -37,9 +37,84 @@ client = Apibanca::Client.new(API_KEY)
 Los bancos pueden ser creados a través de la interfaz web o desde esta gema. Para crear un banco desde la gema, hay que proveer todos los parámetros solicitados por la clase `Apibanca::Bank::BankCreationParams`.
 
 ```ruby
-params = Apibanca::Bank::BankCreationParams.new(name: "BICE", user: "<rut del usuario>", pass: "<password para la web del banco>", account: "<número de cuenta>"
+params = Apibanca::Bank::BankCreationParams.new(name: "BICE", user: "...", pass: "...", account: "...")
 # => #<Apibanca::Bank::BankCreationParams account="..." name="BICE" pass="..." user="...">
+
 banco = Apibanca::Bank.create(client, params)
 # -> POST http://api-banca.herokuapp.com/api/2013-11-4/banks/ [{:bank=>{"name"=>"BICE", "user"=>"...", "pass"=>"...", "account"=>"..."}} params]
-# Banco BICE / 157768441 / unica
+# => (Banco 3304) BICE / <usuario> / <cuenta>
+
+banco.id
+# => 3304
+```
+
+### Estatus del banco
+
+Indica si los parámetros de acceso a la cuenta son correctos. Nota: asegúrate de que lo sean; de otra forma el banco puede bloquear el acceso a la cuenta.
+
+```ruby
+# banco = Apibanca::Bank.create(...)
+banco.status # sólo se puede utilizar cuando cambie a 'ready'. Este cambio de estado toma 5 minutos aproximadamente.
+# => idle
+
+banco.refresh! # recarga el proxy desde el servidor
+# -> GET http://api-banca.herokuapp.com/api/2013-11-4/banks/3304
+# -> GET http://api-banca.herokuapp.com/api/2013-11-4/routines/23444
+# => (Banco 3304) BICE / <usuario> / <cuenta>
+banco.status
+# => working
+
+banco.refresh! # unos minutos más tarde...
+# ...
+banco.status
+# => ready
+```
+
+### Rutinas
+
+Permiten agendar una tarea periódica en un banco. Por ejemplo, leer la cartola.
+
+```ruby
+# Todos los bancos incluyen una rutina inicial que se ejecuta cuando el banco es creado.
+banco.routines
+# => [(Rutina 23444) Setup inicial
+
+# Añadiremos una rutina para leer la cartola y crear depósitos
+banco.add_routine Apibanca::Bank::RoutineCreationParams.new(nombre: "LectorDepósitos", target: "cartola", what_to_do: "acumular")
+# => (Rutina 23449) LectorDepósitos acumular:cartola tasks=0
+
+# Para que la rutina trabaje, hay que indicar la frecuencia
+routine = bank.routines.last
+# => (Rutina 23449) LectorDepósitos acumular:cartola tasks=0
+
+routine.schedule Apibanca::Routine::ScheduleParams.new( unit: "minutes", interval: "60" )
+# -> PATCH http://api-banca.herokuapp.com/api/2013-11-4/routines/23449/schedule [params]
+# => (Rutina 23449) LectorDepósitos acumular:cartola tasks=3
+```
+
+### Descarga de depósitos
+
+A medida que las rutinas de lectura de depósitos procesen la cartola y las transacciones, se puede invocar una función para descargar los depósitos leídos
+
+```ruby
+# arreglo con todos los depósitos
+banco.load_deposits
+# => [...]
+
+banco.deposits.first
+# => (Deposit 209070) 03/01/2014 / cheque / 79.695
+```
+
+### Otras funciones
+
+#### Listado de bancos creados
+
+Es posible cargar un arreglo con los bancos cargados en la cuenta
+
+```ruby
+banks = Apibanca::Bank.index(client)
+# -> GET http://api-banca.herokuapp.com/api/2013-11-4/banks/ 
+# => [(Banco 3304) BICE / <usuario> / <cuenta>, (Banco 3323) SCOTIA / <usuario> / <cuenta>]
+banks.first.id
+# => 3304
 ```

data/lib/apibanca/client/bank.rb

@@ -6,28 +6,23 @@ class Apibanca::Bank < Apibanca::ProxyBase
 		def create client, bank_params
 			raise ArgumentError, "Los parámetros deben ser ApiBanca::Bank::BankCreationParams" unless bank_params.is_a? Apibanca::Bank::BankCreationParams
 			r = client.post url, { bank: bank_params.to_hash }
-			bank = Apibanca::Bank.new(r.body)
-			bank.obj_client = client
-			bank.routines.map! { |r| Apibanca::Routine.new(r) }
+			bank = Apibanca::Bank.new(client, r.body)
+			bank.load_routines! false
 			bank
 		end
 
 		def load client, id, recursive=true
 			r = client.get url("#{id}")
-			bank = Apibanca::Bank.new(r.body)
-			bank.obj_client = client
-			bank.routines.map! { |r| Apibanca::Routine.new(r) }
-			bank.routines.each { |r| r.refresh! } if recursive
+			bank = Apibanca::Bank.new(client, r.body)
+			bank.load_routines! recursive
 			bank
 		end
 
 		def index client, params=nil, recursive=false
 			r = client.get url, params
 			r.body.map do |raw|
-				bank = Apibanca::Bank.new(raw)
-				bank.obj_client = client
-				bank.routines.map! { |r| Apibanca::Routine.new(r) }
-				bank.routines.each { |r| r.refresh! } if recursive
+				bank = Apibanca::Bank.new(client, raw)
+				bank.load_routines! recursive
 				bank
 			end
 		end
@@ -35,10 +30,8 @@ class Apibanca::Bank < Apibanca::ProxyBase
 
 	def refresh! recursive=true
 		r = obj_client.get url
-		old_routines = self.routines
 		self.merge! r.body
-		self.routines = old_routines
-		self.routines.each { |r| r.refresh! } if recursive
+		self.load_routines! recursive
 		self
 	end
 
@@ -51,30 +44,38 @@ class Apibanca::Bank < Apibanca::ProxyBase
 		raise ArgumentError, "Los parámetros deben ser ApiBanca::Bank::RoutineCreationParams" unless routine_params.is_a? Apibanca::Bank::RoutineCreationParams
 		r = obj_client.post url("add_routine"), { routine: routine_params.to_hash }
 		r.body.routines.each do |routine|
-			new_routine = Apibanca::Routine.new(routine) unless self.routines.map { |i| i.id }.include?(routine.id)
-			next unless new_routine
-			new_routine.obj_client = self.obj_client
+			next unless self.routines.any? { |r| r.id == routine.id }
+			new_routine = Apibanca::Routine.new(obj_client, self, routine)
 			new_routine.refresh!
 			self.routines << new_routine
 		end
+		routines.last
 	end
 
 	def delete
-		r = obj_client.delete url
+		obj_client.delete url
 		true
 	end
 
 	def load_deposits params=nil
 		r = obj_client.get url("deposits"), params
-		self.deposits = r.body.map { |d| nd = Apibanca::Deposit.new(d); nd.obj_bank = self; nd.obj_client = obj_client; nd }
+		self.deposits = r.body.map { |d| nd = Apibanca::Deposit.new(obj_client, self, d) }
+	end
+
+	def load_jobs params=nil
+		r = obj_client.get url, params
+		self.jobs = r.body.each do |raw|
+			Apibanca::Job.new(obj_client, raw)
+		end
 	end
 
 	def to_s
-		"Banco #{name} / #{user} / #{account}"
+		"(Banco #{id}) #{name} / #{user} / #{account}"
 	end
 
-	def inspect
-		to_s
+	def load_routines! recursive=true
+		self.routines.map! { |r| Apibanca::Routine.new(self.obj_client, self, r) }
+		self.routines.each { |r| r.refresh! } if recursive
 	end
 
 	class BankCreationParams < Hashie::Dash

data/lib/apibanca/client/deposit.rb

@@ -5,14 +5,15 @@ class Apibanca::Deposit < Apibanca::ProxyBase
 	end
 
 	def to_s
-		"#{self.raw_date} #{self.psd_type ? self.psd_type : self.raw_comment} [#{self.raw_amount}]"
-	end
-
-	def inspect
-		to_s
+		"(Deposit #{id}) #{self.raw_date} / #{self.psd_type ? self.psd_type : self.raw_comment} / #{self.raw_amount}"
 	end
 
 	def history
 		@history ||= load_history
 	end
+
+	def initialize(client, bank, source_hash = nil, default = nil, &block)
+		super(client, source_hash, default, &block)
+		self.obj_bank = bank
+	end
 end

data/lib/apibanca/client/job.rb

@@ -0,0 +1,13 @@
+class Apibanca::Job < Apibanca::ProxyBase
+
+	set_relative_url "jobs"
+
+	class << self
+		def load client, id
+			r = client.get url("#{id}")
+			job = Apibanca::Job.new(client, r.body)
+			job
+		end
+	end
+
+end

data/lib/apibanca/client/proxy_base.rb

@@ -12,4 +12,13 @@ class Apibanca::ProxyBase < Hashie::Mash
 			EOM
 		end
 	end
+
+	def inspect
+		to_s
+	end
+
+	def initialize(client, source_hash = nil, default = nil, &block)
+		super(source_hash, default, &block)
+		self.obj_client = client
+	end
 end

data/lib/apibanca/client/routine.rb

@@ -28,6 +28,21 @@ class Apibanca::Routine < Apibanca::ProxyBase
 		self.tasks = r.body
 	end
 
+	def delete
+		obj_client.delete url
+		self.obj_bank.routines.select! { |r| r.id != self.id } if self.obj_bank.routines.any?
+		true
+	end
+
+	def to_s
+		"(Rutina #{id}) #{nombre} #{target ? "#{what_to_do}:#{target}" : ""} tasks=#{scheduled_tasks} #{!active ? "INACTIVE" : ""}"
+	end
+
+	def initialize(client, bank, source_hash = nil, default = nil, &block)
+		super(client, source_hash, default, &block)
+		self.obj_bank = bank
+	end
+
 	class ScheduleParams < Hashie::Dash
 		property :unit, required: true
 		property :interval, required: true

data/lib/apibanca/client/version.rb

@@ -1,5 +1,5 @@
 module Apibanca
   class Client
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apibanca-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Pablo Marambio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2014-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ files:
 - lib/apibanca/client/deposit.rb
 - lib/apibanca/client/deposit_version.rb
 - lib/apibanca/client/exceptions.rb
+- lib/apibanca/client/job.rb
 - lib/apibanca/client/proxy_base.rb
 - lib/apibanca/client/routine.rb
 - lib/apibanca/client/version.rb