apibanca-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8675cb95bc5d494b86e15a41228a64319b874cec
+  data.tar.gz: 4cf002c3f6709a47fbd01aa0a4c743ed04a28317
+SHA512:
+  metadata.gz: f886239319af97a59f1e46970b68fe358a446ae0cd044b0589ac3ac6950da84acfcc652024ba1feb64ece67f890a65504f3e8af2cbb9b2b8300a374c69fb778f
+  data.tar.gz: b506ef352697aa3d6e580a1d2b31a0063e917c7057c633da8bf099c89d723e891e27397a824335bb48d983d1d1a12b2499110d10bb3fbdd56976a88ec24be0f6

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,62 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 2.0.0" > .rvmrc
+environment_id="ruby-2.0.0-p353@apibanca-client"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.24.7 (stable)" # 1.10.1 seems like a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | __rvm_awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  for __hook in "${rvm_path:-$HOME/.rvm}/hooks/after_use"*
+  do
+    if [[ -f "${__hook}" && -x "${__hook}" && -s "${__hook}" ]]
+    then \. "${__hook}" || true
+    fi
+  done
+  unset __hook
+  if (( ${rvm_use_flag:=1} >= 1 )) # display automatically
+  then
+    if [[ $- == *i* ]] # check for interactive shells
+    then printf "%b" "Using: $(tput setaf 2 2>/dev/null)$GEM_HOME$(tput sgr0 2>/dev/null)
+" # show the user the ruby and gemset they are using in green
+    else printf "%b" "Using: $GEM_HOME
+" # don't use colors in non-interactive shells
+    fi
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS="" \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS="" \grep -vE '^Using|Your bundle is complete'
+# fi

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in apibanca-client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pablo Marambio
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,22 @@
+# Cliente Ruby de API-Banca
+
+`Apibanca::Client` es el cliente de Ruby para `API-Banca`, el wrapper REST sobre los sitios web de los bancos de Chile.
+
+## API-Banca
+
+API-Banca es un wrapper de servicios web REST que simplifica el acceso automatizado a los sitios web de los bancos chilenos. Soporta operaciones como la descarga de cartola y transferencias recibidas. Los bancos soportados por ahora son: `BICE` (banca personas) y `SCOTIA` (banca empresas). Obtén una llave para pruebas ingresando a http://api-banca.herokuapp.com
+
+## Instalación
+
+Agrega esta línea a tu Gemfile
+
+    gem 'apibanca-client'
+
+Y luego ejecuta:
+
+    $ bundle
+
+O bien instálala tú mismo:
+
+    $ gem install apibanca-client
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+end
+
+task :default => :test

data/apibanca-client.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apibanca/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apibanca-client"
+  spec.version       = Apibanca::Client::VERSION
+  spec.authors       = ["Pablo Marambio"]
+  spec.email         = ["yo@pablomarambio.cl"]
+  spec.summary       = "Cliente de API-Banca"
+  spec.description   = "Cliente de API-Banca"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+
+  spec.add_dependency "hashie"
+  spec.add_dependency "faraday"
+  spec.add_dependency "faraday_middleware"
+end

data/lib/apibanca/client/bank.rb

@@ -0,0 +1,80 @@
+class Apibanca::Bank < Apibanca::ProxyBase
+
+	set_relative_url "banks"
+
+	class << self
+		def create 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 }
+			bank = Apibanca::Bank.new(r.body)
+			bank.routines.map! { |r| Apibanca::Routine.new(r) }
+			bank
+		end
+
+		def load id, recursive=true
+			r = Apibanca::Client.get url("#{id}")
+			bank = Apibanca::Bank.new(r.body)
+			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
+			r.body.map do |raw|
+				bank = Apibanca::Bank.new(raw)
+				bank.routines.map! { |r| Apibanca::Routine.new(r) }
+				bank.routines.each { |r| r.refresh! } if recursive
+				bank
+			end
+		end
+	end
+
+	def refresh! recursive=true
+		r = Apibanca::Client.get url
+		old_routines = self.routines
+		self.merge! r.body
+		self.routines = old_routines
+		self.routines.each { |r| r.refresh! } if recursive
+		self
+	end
+
+	def change_password new_pass
+		r = Apibanca::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.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.refresh!
+			self.routines << new_routine
+		end
+	end
+
+	def delete
+		r = Apibanca::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 }
+	end
+
+	class BankCreationParams < Hashie::Dash
+		property :name, :required => true
+		property :user, :required => true
+		property :account, :required => true
+		property :pass, :required => true
+	end
+
+	class RoutineCreationParams < Hashie::Dash
+		property :nombre, :required => true
+		property :target, :required => true
+		property :what_to_do, :required => true
+	end
+end

data/lib/apibanca/client/deposit.rb

@@ -0,0 +1,18 @@
+class Apibanca::Deposit < Apibanca::ProxyBase
+	def load_history
+		h = Apibanca::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
+
+	def to_s
+		"#{self.raw_date} #{self.psd_type ? self.psd_type : self.raw_comment} [#{self.raw_amount}]"
+	end
+
+	def inspect
+		to_s
+	end
+
+	def history
+		@history ||= load_history
+	end
+end

data/lib/apibanca/client/deposit_version.rb

@@ -0,0 +1,10 @@
+class Apibanca::DepositVersion < Apibanca::Deposit
+
+	def load_history
+		raise "Para cargar la historia, debes hacerlo en la versión actual del depósito"
+	end
+
+	def history
+		raise "Para revisar la historia, debes hacerlo en la versión actual del depósito"
+	end
+end

data/lib/apibanca/client/exceptions.rb

@@ -0,0 +1,14 @@
+class Apibanca::Client
+
+	class InvalidOperationError < StandardError
+		attr_reader :remote_backtrace, :remote_errors
+		def initialize remote_backtrace, remote_errors
+			@remote_backtrace = remote_backtrace
+			@remote_errors = remote_errors
+		end
+	end
+
+	class UnauthorizedError < InvalidOperationError; end
+
+	class NotFoundError < InvalidOperationError; end
+end

data/lib/apibanca/client/proxy_base.rb

@@ -0,0 +1,15 @@
+class Apibanca::ProxyBase < Hashie::Mash
+	class << self
+		def set_relative_url relative
+			self.class_eval(<<-EOM, __FILE__, __LINE__ + 1)
+				def url extra=nil
+					"#{relative}/\#{self.id}\#{extra ? "/" + extra : ""}"
+				end
+
+				def self.url extra=nil
+					"#{relative}/\#{extra ? "/" + extra : ""}"
+				end
+			EOM
+		end
+	end
+end

data/lib/apibanca/client/routine.rb

@@ -0,0 +1,35 @@
+class Apibanca::Routine < Apibanca::ProxyBase
+
+	set_relative_url "routines"
+
+	def refresh!
+		r = Apibanca::Client.get url
+		self.merge! r.body
+	end
+
+	def turn_on
+		r = Apibanca::Client.patch url("turn_on")
+		self.merge! r.body
+	end
+
+	def turn_off
+		r = Apibanca::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
+		self.merge! r.body
+	end
+
+	def load_tasks
+		r = Apibanca::Client.get url("tasks")
+		self.tasks = r.body
+	end
+
+	class ScheduleParams < Hashie::Dash
+		property :unit, required: true
+		property :interval, required: true
+	end
+end

data/lib/apibanca/client/version.rb

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

data/lib/apibanca/client.rb

@@ -0,0 +1,101 @@
+require "hashie"
+require "faraday"
+require "faraday_middleware"
+require "apibanca/client/version"
+require "apibanca/client/exceptions"
+require "faraday/request/apibanca_request_logger"
+require "faraday/response/apibanca_errors"
+
+module Apibanca
+	class Client
+
+		class << self
+			def get uri, params=nil
+				Apibanca::Client.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|
+					req.url uri
+					req.headers['bc-auth-token'] = @secret
+					req.body = body if body
+				end
+			end
+
+			def patch uri, body=nil
+				Apibanca::Client.conn_form.patch do |req|
+					req.url uri
+					req.headers['bc-auth-token'] = @secret
+					req.body = body if body
+				end
+			end
+
+			def delete uri
+				Apibanca::Client.conn_form.delete do |req|
+					req.url uri
+					req.headers['bc-auth-token'] = @secret
+				end
+			end
+
+			def conn_form
+				check_requirements!
+				@conn ||= Faraday.new(:url => @base_uri) do |f|
+					f.request :apibanca_request_logger
+					f.request :json
+					f.response :apibanca_errors
+					f.response :mashify
+					f.response :json, :content_type => /\bjson$/
+					f.adapter Faraday.default_adapter
+				end
+			end
+
+			def conn_url
+				check_requirements!
+				@conn ||= Faraday.new(:url => @base_uri) do |f|
+					f.request :apibanca_request_logger
+					f.request :url_encoded
+					f.response :apibanca_errors
+					f.response :mashify
+					f.response :json, :content_type => /\bjson$/
+					f.adapter Faraday.default_adapter
+				end
+			end
+
+			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
+
+			private
+			def check_requirements!
+				raise ArgumentError, "Debe indicar el secreto" unless secret
+				raise ArgumentError, "Debe indicar la URI" unless base_uri
+			end
+		end
+	end
+end
+
+require "apibanca/client/proxy_base"
+require "apibanca/client/bank"
+require "apibanca/client/deposit"
+require "apibanca/client/deposit_version"
+require "apibanca/client/routine"

data/lib/faraday/request/apibanca_request_logger.rb

@@ -0,0 +1,13 @@
+module Faraday
+	class Request
+		class ApibancaRequestLogger < Middleware
+
+			def call(env)
+				puts "  -> #{env[:method].upcase} #{env[:url]} #{env[:body] ? "[#{env[:body]} params]" : "" }"
+				@app.call(env)
+			end
+
+		end
+		Faraday.register_middleware :request, apibanca_request_logger: lambda { ApibancaRequestLogger }
+	end
+end

data/lib/faraday/response/apibanca_errors.rb

@@ -0,0 +1,28 @@
+module Faraday
+	class Response
+		class ApibancaErrors < Middleware
+
+			def call(env)
+				@app.call(env).on_complete do
+					resp = env[:response].body
+					if env[:status] >= 400 && env[:status] <= 500
+						if resp.respond_to? :backtrace
+							case env[:status]
+							when 401, 403
+								raise Apibanca::Client::UnauthorizedError.new(resp.backtrace, nil), resp.error
+							when 404
+								raise Apibanca::Client::UnauthorizedError.new(resp.backtrace, nil), resp.error
+							else
+								raise Apibanca::Client::InvalidOperationError.new(resp.backtrace, resp[:"object-errors"]), resp.error
+							end
+						else
+							raise "Error inesperado #{env[:status]}"
+						end
+					end
+				end
+			end
+
+		end
+		Faraday.register_middleware :response, apibanca_errors: lambda { ApibancaErrors }
+	end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'apibanca/client'
+
+require 'minitest/autorun'

data/test/test_apibanca/client.rb

@@ -0,0 +1,11 @@
+require 'minitest_helper'
+
+class TestApibanca::Client < MiniTest::Unit::TestCase
+  def test_that_it_has_a_version_number
+    refute_nil ::Apibanca::Client::VERSION
+  end
+
+  def test_it_does_something_useful
+    assert false
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: apibanca-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pablo Marambio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Cliente de API-Banca
+email:
+- yo@pablomarambio.cl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apibanca-client.gemspec
+- lib/apibanca/client.rb
+- lib/apibanca/client/bank.rb
+- lib/apibanca/client/deposit.rb
+- lib/apibanca/client/deposit_version.rb
+- lib/apibanca/client/exceptions.rb
+- lib/apibanca/client/proxy_base.rb
+- lib/apibanca/client/routine.rb
+- lib/apibanca/client/version.rb
+- lib/faraday/request/apibanca_request_logger.rb
+- lib/faraday/response/apibanca_errors.rb
+- test/minitest_helper.rb
+- test/test_apibanca/client.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Cliente de API-Banca
+test_files:
+- test/minitest_helper.rb
+- test/test_apibanca/client.rb