apibanca-client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8675cb95bc5d494b86e15a41228a64319b874cec
-  data.tar.gz: 4cf002c3f6709a47fbd01aa0a4c743ed04a28317
+  metadata.gz: a05aac810bc32fe182122fb2cd8ef1961d683928
+  data.tar.gz: f2775c0ade0e6ec278975bcd0cc5cab7cc05dcf4
 SHA512:
-  metadata.gz: f886239319af97a59f1e46970b68fe358a446ae0cd044b0589ac3ac6950da84acfcc652024ba1feb64ece67f890a65504f3e8af2cbb9b2b8300a374c69fb778f
-  data.tar.gz: b506ef352697aa3d6e580a1d2b31a0063e917c7057c633da8bf099c89d723e891e27397a824335bb48d983d1d1a12b2499110d10bb3fbdd56976a88ec24be0f6
+  metadata.gz: 4235bcaabe647464ebfe812462eb381b3a0fefcc63426193a48609fb82b8d92520c466bdfa88f50e8ed18f7abfec1c5947a29ad9e6048ed9600bccd372880596
+  data.tar.gz: fc953a05aeae0d3f9cd95451bcce25f5d4e77909093375a26578e92b5c81b40a97c17e28d9b993b50b834672773a7efae438539f6f53c48565c602d0a5567681

data/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Bitácora de cambios
+
+## 0.0.2
+
+### Configuración del cliente
+El cliente ya no guarda el secreto y la URI de manera estática. En vez de eso, (a) dichos parámetros son argumentos del constructor, y (b) el cliente debe ser pasado como argumento en los métodos estáticos de `Apibanca::Bank`.
+
+```ruby
+# a)
+# Antes: Apibanca::Client.configure { |c| c.secret = "API_KEY..."}
+client = Apibanca::Client.new("API_KEY...")
+
+# b)
+# Antes: bank = Apibanca::Bank.create(params)
+bank = Apibanca::Bank.create(client, params)
+```
+
+### Búsqueda de bancos
+La función `Bank.index` ahora recibe un hash de parámetros opcionales. Ese hash soporta `name` y `user`.
+
+```ruby
+banks = Apibanca::Bank.index(client, name: "BICE") # retorna todos los bancos con name == BICE
+```

data/README.md

@@ -20,3 +20,26 @@ O bien instálala tú mismo:
 
     $ gem install apibanca-client
 
+## Uso
+
+### Instanciar el cliente
+
+Para realizar cualquier operación desde la gema, hay que autentificarse con la API-Key obtenida en http://api-banca.herokuapp.com.
+
+```ruby
+# Obtenida desde http://api-banca.herokuapp.com
+API_KEY = "b3e0f65c-dea6-4003-d9d0-9a8745d9988"
+client = Apibanca::Client.new(API_KEY)
+```
+
+### Crear un banco
+
+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>"
+# => #<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
+```

data/lib/apibanca/client.rb

@@ -8,17 +8,16 @@ require "faraday/response/apibanca_errors"
 
 module Apibanca
 	class Client
-
-		class << self
+		module Http
 			def get uri, params=nil
-				Apibanca::Client.conn_url.get do |req|
+				conn_url.get do |req|
 					req.url uri, params
 					req.headers['bc-auth-token'] = @secret
 				end
 			end
 
 			def post uri, body=nil
-				Apibanca::Client.conn_form.post do |req|
+				conn_form.post do |req|
 					req.url uri
 					req.headers['bc-auth-token'] = @secret
 					req.body = body if body
@@ -26,7 +25,7 @@ module Apibanca
 			end
 
 			def patch uri, body=nil
-				Apibanca::Client.conn_form.patch do |req|
+				conn_form.patch do |req|
 					req.url uri
 					req.headers['bc-auth-token'] = @secret
 					req.body = body if body
@@ -34,7 +33,7 @@ module Apibanca
 			end
 
 			def delete uri
-				Apibanca::Client.conn_form.delete do |req|
+				conn_form.delete do |req|
 					req.url uri
 					req.headers['bc-auth-token'] = @secret
 				end
@@ -42,7 +41,7 @@ module Apibanca
 
 			def conn_form
 				check_requirements!
-				@conn ||= Faraday.new(:url => @base_uri) do |f|
+				@conn_form ||= Faraday.new(:url => @base_uri) do |f|
 					f.request :apibanca_request_logger
 					f.request :json
 					f.response :apibanca_errors
@@ -54,7 +53,7 @@ module Apibanca
 
 			def conn_url
 				check_requirements!
-				@conn ||= Faraday.new(:url => @base_uri) do |f|
+				@conn_url ||= Faraday.new(:url => @base_uri) do |f|
 					f.request :apibanca_request_logger
 					f.request :url_encoded
 					f.response :apibanca_errors
@@ -63,33 +62,19 @@ module Apibanca
 					f.adapter Faraday.default_adapter
 				end
 			end
+		end
+		include Http
 
-			def configure &block
-				raise ArgumentError, "El bloque debe recibir un argumento" unless block.arity == 1
-				yield self
-			end
-
-			def secret= value
-				@secret = value
-			end
-
-			def secret
-				@secret
-			end
-
-			def base_uri= value
-				@base_uri = value
-			end
-
-			def base_uri
-				@base_uri ||= "http://localhost:3000/api/2013-11-4"
-			end
+		def initialize secret, api_uri = "http://api-banca.herokuapp.com/api/2013-11-4"
+			raise ArgumentError, "Debe indicar el secreto para acceder a la API" unless secret
+			@secret = secret
+			@base_uri = api_uri
+		end
 
-			private
-			def check_requirements!
-				raise ArgumentError, "Debe indicar el secreto" unless secret
-				raise ArgumentError, "Debe indicar la URI" unless base_uri
-			end
+		private
+		def check_requirements!
+			raise ArgumentError, "Debe indicar el secreto" unless @secret
+			raise ArgumentError, "Debe indicar la URI" unless @base_uri
 		end
 	end
 end

data/lib/apibanca/client/bank.rb

@@ -3,26 +3,29 @@ class Apibanca::Bank < Apibanca::ProxyBase
 	set_relative_url "banks"
 
 	class << self
-		def create bank_params
+		def create client, bank_params
 			raise ArgumentError, "Los parámetros deben ser ApiBanca::Bank::BankCreationParams" unless bank_params.is_a? Apibanca::Bank::BankCreationParams
-			r = Apibanca::Client.post url, { bank: bank_params.to_hash }
+			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
 		end
 
-		def load id, recursive=true
-			r = Apibanca::Client.get url("#{id}")
+		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
 		end
 
-		def index recursive=false
-			r = Apibanca::Client.get url
+		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
@@ -31,7 +34,7 @@ class Apibanca::Bank < Apibanca::ProxyBase
 	end
 
 	def refresh! recursive=true
-		r = Apibanca::Client.get url
+		r = obj_client.get url
 		old_routines = self.routines
 		self.merge! r.body
 		self.routines = old_routines
@@ -40,29 +43,38 @@ class Apibanca::Bank < Apibanca::ProxyBase
 	end
 
 	def change_password new_pass
-		r = Apibanca::Client.patch url("change_password"), pass: new_pass
+		r = obj_client.patch url("change_password"), pass: new_pass
 		true
 	end
 
 	def add_routine routine_params
 		raise ArgumentError, "Los parámetros deben ser ApiBanca::Bank::RoutineCreationParams" unless routine_params.is_a? Apibanca::Bank::RoutineCreationParams
-		r = Apibanca::Client.post url("add_routine"), { routine: routine_params.to_hash }
+		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
 			new_routine.refresh!
 			self.routines << new_routine
 		end
 	end
 
 	def delete
-		r = Apibanca::Client.delete url
+		r = obj_client.delete url
 		true
 	end
 
 	def load_deposits params=nil
-		r = Apibanca::Client.get url("deposits"), params
-		self.deposits = r.body.map { |d| nd = Apibanca::Deposit.new(d); nd.obj_bank = self; nd }
+		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 }
+	end
+
+	def to_s
+		"Banco #{name} / #{user} / #{account}"
+	end
+
+	def inspect
+		to_s
 	end
 
 	class BankCreationParams < Hashie::Dash

data/lib/apibanca/client/deposit.rb

@@ -1,6 +1,6 @@
 class Apibanca::Deposit < Apibanca::ProxyBase
 	def load_history
-		h = Apibanca::Client.get obj_bank.url("deposits/#{self.id}/history")
+		h = obj_client.get obj_bank.url("deposits/#{self.id}/history")
 		@history = h.body.map { |d| dv = Apibanca::DepositVersion.new(d); dv.obj_deposit = self; dv }
 	end
 

data/lib/apibanca/client/routine.rb

@@ -3,28 +3,28 @@ class Apibanca::Routine < Apibanca::ProxyBase
 	set_relative_url "routines"
 
 	def refresh!
-		r = Apibanca::Client.get url
+		r = obj_client.get url
 		self.merge! r.body
 	end
 
 	def turn_on
-		r = Apibanca::Client.patch url("turn_on")
+		r = obj_client.patch url("turn_on")
 		self.merge! r.body
 	end
 
 	def turn_off
-		r = Apibanca::Client.patch url("turn_off")
+		r = obj_client.patch url("turn_off")
 		self.merge! r.body
 	end
 
 	def schedule params
 		raise ArgumentError, "Los parámetros deben ser ApiBanca::Routine::ScheduleParams" unless params.is_a? Apibanca::Routine::ScheduleParams
-		r = Apibanca::Client.patch url("schedule"), params.to_hash
+		r = obj_client.patch url("schedule"), params.to_hash
 		self.merge! r.body
 	end
 
 	def load_tasks
-		r = Apibanca::Client.get url("tasks")
+		r = obj_client.get url("tasks")
 		self.tasks = r.body
 	end
 

data/lib/apibanca/client/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apibanca-client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Pablo Marambio
@@ -104,6 +104,7 @@ files:
 - .gitignore
 - .rvmrc
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md