bipbop-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 944d39e25689e922a9aad85c6e57e1e9ce2352d2
+  data.tar.gz: 65a6116b0467152d3751595e81598c4a0f64e82a
+SHA512:
+  metadata.gz: d9db4807c800694c866934b7ab2266cb21c9603cdd5af08d91fdbcb5851213d6b71062cf9f9bfa92a0c6639c161e372cad117ce7fb4105f76d0890074b845e22
+  data.tar.gz: 829fd7434c3a6b4009081f9aea6cd3f9f67e5bcb0160c203381cfa68bce2c8d5890ca9d31ac792ae298d017a151e0294908c37b7c6b9ae73e5442517e4f1d602

data/README.md

@@ -0,0 +1,86 @@
+# Bipbop Ruby
+
+# Instalação
+
+Simples instalação via ruby gem
+``` 
+# gem install bipbop-client
+```
+Biblioteca em Ruby para interação com a Bipbop API. Com ela você pode fazer consulta de dados cadastrais, consulta do Perfil Consumidor para SAC, Correios, placas de veículos entre outras bases. Tudo que você precisa é adquirir uma chave de API válida entrando em contato com a Bipbop.
+
+# Buscando o nome através do CPF/CNPJ
+
+Existe uma classe especial chamada `NameByCPFCNPJ` cujo método estático *evaluate* pode ser usado para consultar o nome através do CPF/CNPJ, passando-se o CPF/CNPJ como string e opcionalmente a data de nascimento como DATETIME ou Inteiro:
+
+```ruby
+puts Bipbop::Client::NameByCpfCnpj.evaluate($cpf, $nasc)
+```
+
+# Como utilizar
+
+Com uma chave de API válida em mãos você pode interagir com bancos os quais sua chave tem acesso. Nesse repositório você encontrará o arquivo __example.rb__ com o codigo a abaixo.
+
+O primeiro passo é saber quais são esses bancos. Para isso temos a classe `ServiceDiscovery` que usa uma instância de `WebService`, criada a partir de sua chave:
+
+```ruby
+require 'bipbop'
+
+Bipbop::Client::Config.new({:api_key => # sua chave #})
+
+webservice = Bipbop::Client::Webservice.new
+service_discovery = Bipbop::Client::ServiceDiscovery.factory(webservice)
+
+puts "\n\n== Listando todos os databases ==\n\n"
+service_discovery.list_databases() { |database_info|  
+  database = service_discovery.get_database(database_info.first['name'])
+  puts "Available Database: %s\nDescription: %s\nURL: %s\n\n" % [database.name(), database.get("description"), database.get("url")]
+}
+
+```
+
+Vamos tomar como exemplo o database __PLACA__ e descobrir quais tabelas podemos consultar e com quais campos:
+
+```ruby
+puts "\n== Listando tabelas de PLACA ==\n\n"
+database_placa = service_discovery.get_database('PLACA')
+database_placa.list_tables() { |table_info|
+  table = database_placa.get_table(table_info.first['name'])
+  puts "Available Table: %s\nDescription: %s\nURL: %s\n\n" % [table.name(), table.get("description"), table.get("url")]
+}
+
+```
+
+Nossa listagem retornou a tabela __CONSULTA__ mas quais serão os campos que podemos usar como parâmetros em nossa consulta? Vamos descobrir:
+
+```ruby
+tabela_consulta = database_placa.get_table('CONSULTA')
+puts "\n== Listando campos de CONSULTA ==\n\n"
+
+tabela_consulta.get_fields() { |field|  
+  puts "Available Field: %s\n\n" % field.name() 
+}
+```
+
+Nossa busca retornou o campo __placa__.
+
+Com esses dados em mãos torna-se simples montar nossa consulta. Basta utilizarmos o método *post* de `WebService` da seguinte forma:
+
+```php
+placa = webservice.post("SELECT FROM 'PLACA'.'CONSULTA'", {
+    "placa" => "XXX9999"
+});
+```
+
+Esse método retorna um [Nokogiri::XML::Document](http://www.rubydoc.info/github/sparklemotion/nokogiri/master/Nokogiri/XML/Document) 
+
+```ruby
+// Visualizando as tags do documento retornado
+puts placa
+
+// Recuperando a marca do veículo
+puts (placa.xpath("string(//BPQL//body//marca/.)"));
+```
+
+# Mais informações
+
+Para mais informações e aquisição de uma chave de api acesse [http://api.bipbop.com.br](http://api.bipbop.com.br).

data/lib/bipbop/cnpj.rb

@@ -0,0 +1,29 @@
+module Bipbop
+  module Client
+    module CpfCnpjValidation
+      class Cnpj
+        # Escrito por: André Camargo < andre@boaideia.inf.br > http://blog.boaideia.inf.br
+        def is_valid?(cnpj)
+          return false if cnpj.nil?
+          nulos = %w{11111111111111 22222222222222 33333333333333 44444444444444 55555555555555 66666666666666 77777777777777 88888888888888 99999999999999 00000000000000}
+          valor = cnpj.scan /[0-9]/
+          if valor.length == 14
+            unless nulos.member?(valor.join)
+              valor = valor.collect{|x| x.to_i}
+              soma = valor[0]*5+valor[1]*4+valor[2]*3+valor[3]*2+valor[4]*9+valor[5]*8+valor[6]*7+valor[7]*6+valor[8]*5+valor[9]*4+valor[10]*3+valor[11]*2
+              soma = soma - (11*(soma/11))
+              resultado1 = (soma==0 || soma==1) ? 0 : 11 - soma
+              if resultado1 == valor[12]
+                soma = valor[0]*6+valor[1]*5+valor[2]*4+valor[3]*3+valor[4]*2+valor[5]*9+valor[6]*8+valor[7]*7+valor[8]*6+valor[9]*5+valor[10]*4+valor[11]*3+valor[12]*2
+                soma = soma - (11*(soma/11))
+                resultado2 = (soma == 0 || soma == 1) ? 0 : 11 - soma
+                return true if resultado2 == valor[13]
+              end
+            end
+          end
+          return false
+        end
+      end
+    end
+  end
+end

data/lib/bipbop/config.rb

@@ -0,0 +1,13 @@
+module Bipbop
+  module Client
+    class Config
+      @@key = '6057b71263c21e4ada266c9d4d4da613'
+      def initialize(config)
+        @@key = config[:bipbop_api_key]
+      end
+      def self.key
+        @@key
+      end
+    end
+  end
+end

data/lib/bipbop/cpf.rb

@@ -0,0 +1,30 @@
+module Bipbop
+  module Client
+    module CpfCnpjValidation
+      class Cpf
+        # Escrito por: André Camargo < andre@boaideia.inf.br > http://blog.boaideia.inf.br
+        def is_valid?(cpf)
+          return false if cpf.nil?
+          nulos = %w{12345678909 11111111111 22222222222 33333333333 44444444444 55555555555 66666666666 77777777777 88888888888 99999999999 00000000000}
+          valor = cpf.scan /[0-9]/
+          if valor.length == 11
+            unless nulos.member?(valor.join)
+              valor = valor.collect{|x| x.to_i}
+              soma = 10*valor[0]+9*valor[1]+8*valor[2]+7*valor[3]+6*valor[4]+5*valor[5]+4*valor[6]+3*valor[7]+2*valor[8]
+              soma = soma - (11 * (soma/11))
+              resultado1 = (soma == 0 or soma == 1) ? 0 : 11 - soma
+              if resultado1 == valor[9]
+                soma = valor[0]*11+valor[1]*10+valor[2]*9+valor[3]*8+valor[4]*7+valor[5]*6+valor[6]*5+valor[7]*4+valor[8]*3+valor[9]*2
+                soma = soma - (11 * (soma/11))
+                resultado2 = (soma == 0 or soma == 1) ? 0 : 11 - soma
+                return true if resultado2 == valor[10]
+              end
+            end
+          end
+          return false
+          true
+        end
+      end
+    end
+  end
+end

data/lib/bipbop/database.rb

@@ -0,0 +1,54 @@
+module Bipbop
+  module Client
+    class Database
+      
+      KEY_TABLE_NAME = "name"
+      KEY_TABLE_DESCRIPTION = "description"
+      KEY_TABLE_URL = "url"
+      
+      @ws
+      @dom_node
+      @dom
+    
+      # Instância um Database
+      # @param BIPBOP::Client::Webservice ws
+      # @param Nokogiri::XML::Node dom_node
+      # @param Nokogiri::XML::Document dom
+     
+      def initialize(ws, dom_node, dom)
+        @ws = ws
+        @dom_node = dom_node
+        @dom = dom
+      end
+      
+      # Captura o nome do database
+      def name
+        @dom_node['name']
+      end
+      
+      def list_tables
+        @dom_node.xpath("table").each { |node|
+          yield [
+            KEY_TABLE_NAME => node['name'],
+            KEY_TABLE_DESCRIPTION => node["description"],
+            KEY_TABLE_URL => node["url"]
+          ]
+        }
+      end
+      
+      def get_table(name)
+        table = @dom_node.xpath(".//table[@name='%s']" % name.gsub(/[^a-z0-9\-_]/i, ''))
+        if (table.length == 0) 
+          raise Exception, "Can't find that table."
+        end
+        
+        Bipbop::Client::Table.new(@ws, self, table.first, @dom)
+        
+      end
+      
+      def get(attribute)
+        @dom_node[attribute]
+      end
+    end
+  end
+end

data/lib/bipbop/exception.rb

@@ -0,0 +1,41 @@
+module Bipbop
+  module Client
+    class Exception < Exception
+      INVALID_ARGUMENT = 1
+
+      @bipbop_code
+      @bipbop_source
+      @bipbop_id
+      @bipbop_message
+      @bipbop_pushable
+
+      def get_bipbop_code
+        @bipbop_code
+      end
+
+      def get_bipbop_source
+        @bipbop_source
+      end
+
+      def get_bipbop_id
+        @bipbop_id
+      end
+
+      def get_bipbop_message
+        @bipbop_message
+      end
+
+      def get_bipbop_pushable
+        @bipbop_pushable
+      end
+
+      def set_attributes(code, source, id, message, pushable)
+        @bipbop_code = code
+        @bipbop_source = source
+        @bipbop_id = id
+        @bipbop_message = message
+        @bipbop_pushable = pushable
+      end
+    end
+  end
+end

data/lib/bipbop/field.rb

@@ -0,0 +1,47 @@
+module Bipbop
+  module Client
+    #Informações a respeito de um campo da BIPBOP
+    class Field
+      
+      @dom_node
+      @dom
+      @table
+      @database
+    
+      def initialize(table, database, dom_node, dom)
+        @table = table
+        @database = database
+        @dom = dom
+        @dom_node = dom_node
+      end
+      def name
+        @dom_node['name']
+      end
+      
+      #Informação do XML a respeito de um campo
+      def get(attribute)
+        @dom_node[attribute]
+      end
+      
+      #Lista de opções do campo
+      def options
+        self.read_options(@dom_node.xpath(".//option"))
+      end
+      
+      # Lista de opções do grupo
+      def group_options
+        @dom_node.xpath(".//optgroup").to_a.map { |node|  
+          [node['value'], self.read_options(node.xpath(".//option"))]
+        }
+      end
+      
+      #Lista de opções disponíveis
+      protected 
+      def read_options(node_list)
+        node_list.to_a.map { |obj|  
+          [obj['value'], obj.text]
+        }
+      end
+    end
+  end
+end

data/lib/bipbop/name_by_cpf_cnpj.rb

@@ -0,0 +1,28 @@
+module Bipbop
+  module Client
+    class NameByCpfCnpj
+      # birtyday Time
+      def self.evaluate(cpf_cnpj, birtyday = nil)
+        cpf = Bipbop::Client::CpfCnpjValidation::Cpf.new
+        cnpj = Bipbop::Client::CpfCnpjValidation::Cnpj.new
+
+        if (cpf.is_valid?(cpf_cnpj)) 
+          if (!birtyday.instance_of? Time)
+            raise raise Bipbop::Client::Exception.new("É necessário informar a data de nascimento para consultar um CPF.")
+          end
+        elsif (!cnpj.is_valid?(cpf_cnpj)) 
+          raise Bipbop::Client::Exception.new("O documento informado não é um CPF ou CNPJ válido.")
+        end
+        
+        if (birtyday.instance_of? Time)
+          birtyday = birtyday.strftime('%d-%m-%Y')
+        end 
+        
+        Bipbop::Client::Webservice.new.post("SELECT FROM 'BIPBOPJS'.'CPFCNPJ'", {
+            "documento" => cpf_cnpj,
+            "nascimento" => birtyday
+          }).xpath('string(//BPQL//body//nome//.)')
+      end
+    end
+  end
+end

data/lib/bipbop/push.rb

@@ -0,0 +1,59 @@
+module Bipbop
+  module Client
+    class Push
+      
+      PARAMETER_PUSH_QUERY = "pushQuery"
+      PARAMETER_PUSH_INTERVAL = "pushInterval"
+      PARAMETER_JURISTEK_CALLBACK = "juristekCallback"
+      PARAMETER_PUSH_LABEL = "pushLabel"
+      PARAMETER_PUSH_AT = "pushAt"
+      PARAMETER_PUSH_TRY_IN = "pushTryIn"
+      PARAMETER_PUSH_MAX_VERSION = "pushMaxVersion"
+      PARAMETER_PUSH_EXPIRE = "pushExpire"
+      PARAMETER_PUSH_PRIORITY = "pushPriority"
+      PARAMETER_PUSH_ID = "id"
+      PARAMETER_PUSH_CALLBACK = "pushCallback"
+      
+      @ws
+      
+      def initialize(ws)
+        @ws = ws
+      end
+      
+      # Cria um novo PUSH
+      def create(label, push_callback, query, parameters)
+        @ws.post("INSERT INTO 'PUSH'.'JOB'", parameters.merge({
+              PARAMETER_PUSH_LABEL => label,
+              PARAMETER_PUSH_QUERY => query,
+              PARAMETER_PUSH_CALLBACK => push_callback
+            }))
+      end
+      # Remove PUSH
+      def delete(id)
+        @ws.post("DELETE FROM 'PUSH'.'JOB'", {"id" => id}).xpath('string(//BPQL//body//id)')
+      end
+      
+      # Abre um documento criado
+      def open(id, label = nil)
+        @ws.post("SELECT FROM 'PUSH'.'DOCUMENT'", {"id" => id , "label" => label})
+      end
+      
+      # Muda o intervalo do PUSH
+      def change_interval(id, interval)
+        @ws.post("UPDATE 'PUSH'.'PUSHINTERVAL'", {
+            PARAMETER_PUSH_ID => id,
+            PARAMETER_PUSH_INTERVAL => interval,
+          })
+      end
+      
+      # Muda a versão máxima do PUSH
+      def change_max_version(id, max_version)
+        @ws.post("UPDATE 'PUSH'.'PUSHMAXVERSION'", {
+            PARAMETER_PUSH_ID => id,
+            PARAMETER_PUSH_MAX_VERSION => max_version,
+          })
+      end
+      
+    end
+  end
+end

data/lib/bipbop/push_juristek.rb

@@ -0,0 +1,27 @@
+module Bipbop
+  module Client
+    class PushJuristek < Bipbop::Client::Push
+      
+      PARAMETER_PUSH_JURISTEK_CALLBACK = "juristekCallback"
+      PARAMETER_PUSH_JURISTEK_QUERY = "data"
+      
+      # Cria um novo PUSH
+      def create(label, push_callback, query, parameters) 
+        data = Array.new
+        if !parameters.nil? && !parameters.empty?
+          parameters.each { |key, value| 
+            data.push("'%s' = '%s'" % [key.to_s.gsub(/\'/i, ''), value.to_s.gsub(/\'/i,'')])
+          }
+          query += ((query =~ /where/i) == nil ? ' WHERE ' : '' ) + data.join(' AND ')
+          
+          @ws.post("INSERT INTO 'PUSHJURISTEK'.'JOB'", parameters.merge({
+                PARAMETER_PUSH_LABEL => label,
+                PARAMETER_PUSH_QUERY => "SELECT FROM 'JURISTEK'.'PUSH'",
+                PARAMETER_PUSH_JURISTEK_QUERY => query,
+                PARAMETER_PUSH_JURISTEK_CALLBACK => push_callback
+              }))
+        end      
+      end
+    end
+  end
+end

data/lib/bipbop/receiver.rb

@@ -0,0 +1,20 @@
+module BIpbop
+  module Client
+    # Recebe os parâmetros do PUSH
+    class Receiver
+      # Versão do documento
+      @version
+
+      # ID do documento
+      @documentId
+
+      # Nome do documento
+      @label
+      
+      def initialize
+        
+      end
+      
+    end
+  end
+end

data/lib/bipbop/service_discovery.rb

@@ -0,0 +1,42 @@
+module Bipbop
+  module Client
+    class ServiceDiscovery
+      
+      @ws
+      @list_databases
+
+      KEY_DATABASE_NAME = "name"
+      KEY_DATABASE_DESCRIPTION = "description"
+      KEY_DATABASE_URL = "url"
+      
+      def initialize (ws, databases)
+        @ws = ws
+        @list_databases = databases
+      end
+      
+      def self.factory(ws, parameters = {})
+        ServiceDiscovery.new(ws, ws.post("SELECT FROM 'INFO'.'INFO'", parameters))
+      end
+      
+      def list_databases
+        @list_databases.xpath("//BPQL//body//database").each { |node| 
+          yield [
+            KEY_DATABASE_NAME => node["name"],
+            KEY_DATABASE_DESCRIPTION => node["description"],
+            KEY_DATABASE_URL => node["url"]
+          ]
+        }      
+      end
+      
+      def get_database(name)
+        database = @list_databases.xpath("/BPQL/body/database[@name='%s']" % [name.gsub(/[^a-z0-9]/i, '')])
+        if (database.length == 0) 
+            raise Exception, "Can't find that database."
+        end
+        
+        Bipbop::Client::Database.new(@ws, database.first, @list_databases)
+        
+      end
+    end
+  end
+end

data/lib/bipbop/service_discovery_juristek.rb

@@ -0,0 +1,15 @@
+module Bipbop
+  module Client
+    class ServiceDiscoveryJuristek < Bipbop::Client::ServiceDiscovery
+      
+      PARAMETER_OAB = "OAB"
+
+      def self.factory(ws, parameters = {})
+        ServiceDiscoveryJuristek.new(ws, ws.post("SELECT FROM 'JURISTEK'.'INFO'", parameters.merge(
+              'data' => !parameters[PARAMETER_OAB].nil? && parameters[PARAMETER_OAB] != nil ? 
+                "SELECT FROM 'INFO'.'INFO'" : "SELECT FROM 'INFO'.'INFO' WHERE 'TIPO_CONSULTA' = 'OAB'"
+            )))
+      end
+    end
+  end
+end

data/lib/bipbop/table.rb

@@ -0,0 +1,32 @@
+module Bipbop
+  module Client
+    class Table
+      @ws
+      @dom_node
+      @dom
+      @database
+      
+      def initialize(ws, database, dom_node, dom)
+        @ws = ws
+        @dom_node = dom_node
+        @dom = dom
+        @database = database
+      end
+      
+      def get_fields
+        @dom_node.xpath(".//field").each { |field|
+          yield Bipbop::Client::Field.new(self, @database, field, @dom)
+        }        
+      end
+      
+      def name
+        @dom_node['name']
+      end
+      
+      def get(attribute)
+        @dom_node[attribute]
+      end
+      
+    end
+  end
+end

data/lib/bipbop/version.rb

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

data/lib/bipbop/webservice.rb

@@ -0,0 +1,52 @@
+require 'curl'
+require 'nokogiri'
+require 'open-uri'
+
+module Bipbop
+  module Client
+    class Webservice 
+  
+      ENDPOINT = "https://irql.bipbop.com.br/";
+      REFERRER = "https://juridicocorrespondentes.com.br/";
+      PARAMETER_QUERY = "q";
+      PARAMETER_APIKEY = "apiKey";
+      
+      # Inicializa a API
+      # @param string $apiKey Chave de acesso da BIPBOP
+      # @return Nokogiri::XML::Document
+  
+      def post (query, parameters = {})
+    
+        curl = CURL.new({'cookies_enable' => false})
+        response = curl.post(ENDPOINT, parameters.merge({
+              PARAMETER_QUERY =>  query,
+              PARAMETER_APIKEY => Bipbop::Client::Config.key
+            }));
+        document = Nokogiri::XML(response)
+        self::assert(document)
+     
+        document
+    
+      end
+      # Realiza um assertion do documento
+      def assert(doc)
+        node = doc.xpath('//BPQL//header//exception')
+      
+        if node.length > 0
+          node_exception = node.first
+          source = node_exception["source"]
+          code = node_exception["code"]
+          id = node_exception["id"]
+          pushable = (node_exception["pushable"] || node_exception["push"]) === true
+          message = node_exception.text
+          
+          exception = Bipbop::Client::Exception.new("[%s:%s/%s] %s" % [code, source, id, message, pushable])
+          exception.set_attributes(code, source, id, message, pushable)
+          
+          raise exception
+        
+        end
+      end
+    end
+  end
+end

data/lib/bipbop.rb

@@ -0,0 +1,20 @@
+require "bipbop/version"
+require "bipbop/database"
+require "bipbop/webservice"
+require "bipbop/exception"
+require "bipbop/field"
+require "bipbop/table"
+require "bipbop/service_discovery"
+require "bipbop/push"
+require "bipbop/push_juristek"
+require "bipbop/service_discovery_juristek"
+require "bipbop/config"
+require "bipbop/name_by_cpf_cnpj"
+require "bipbop/cpf"
+require "bipbop/cnpj"
+
+module Bipbop
+  module Client
+
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: bipbop-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Otavio Carvalho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Library for communicating with BIPBOP
+email:
+- otaviolcarvalho@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/bipbop.rb
+- lib/bipbop/cnpj.rb
+- lib/bipbop/config.rb
+- lib/bipbop/cpf.rb
+- lib/bipbop/database.rb
+- lib/bipbop/exception.rb
+- lib/bipbop/field.rb
+- lib/bipbop/name_by_cpf_cnpj.rb
+- lib/bipbop/push.rb
+- lib/bipbop/push_juristek.rb
+- lib/bipbop/receiver.rb
+- lib/bipbop/service_discovery.rb
+- lib/bipbop/service_discovery_juristek.rb
+- lib/bipbop/table.rb
+- lib/bipbop/version.rb
+- lib/bipbop/webservice.rb
+homepage: https://github.com/OTATA/bipbop
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Library for communicating with BIPBOP
+test_files: []