sacsp_gateway 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0934b3a235c107c37650f2fdf5c0248eb027b53e
+  data.tar.gz: dfe016d85aaf280cde511707c7a5c202580f559a
+SHA512:
+  metadata.gz: 5a285cbaa8fe95c818dcb7d2fd6153fbce245fb147d6765cf08d0d89d87357f024c338bbeddaefd9dd3939f838f4144276601328f1e0954787ae5d47a8c46296
+  data.tar.gz: d822cd196d3a7e5f724f5b481e0afabf9f35f5105cfaa8338926755ae99172ff8fd61d971c339d1bb64821a29b18a02d3b8290e23a5d08d0b28365f9b9a0e37e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+ruby '2.2.3'
+# Specify your gem's dependencies in sacsp_gateway.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Marcelo Vitor F. Menezes
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Marcelo Menezes
+
+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,112 @@
+# SacspGateway
+
+Gem EXPERIMENTAL para criação de chamados no SAC da Prefeitura de São Paulo.
+Criei esta gem somente para fins de estudos e ela não deve ser utilizada para aplicações em produção.
+
+## Instalação
+
+Adicione a linha abaixo ao seu Gemfile:
+
+```ruby
+gem 'sacsp_gateway'
+```
+
+e execute:
+
+    $ bundle
+
+Ou instale diretamente com o comando abaixo:
+
+    $ gem install sacsp_gateway
+
+## Utilização
+
+Para criar um chamado no SAC da prefeitura de São Paulo utilizando esta gem, siga os passos abaixo nas mesma ordem (eu preferi manter os nomes como step_x uma vez que fica mais fácil de lembrar a ordem que devem ser chamados:
+
+```ruby
+#0 - Buscar a lista de assuntos que podem ser utilizados na criação de um ticket (ex.: Lixo/Limpeza, Buracos, etc.)
+subjects = SacspGateway.get_subjects #Você pode manter o resultado deste método em cache
+```
+
+##IMPORTANTE: Os métodos abaixo devem ser chamados em ordem.
+
+Iniciando o processo de criação do chamado:
+
+```ruby
+#1 - Envie o assunto do chamado, que foi selecionado com base no método que busca os assuntos.
+subject_key = subjects.last[:key] #ex.: "001Buraco"
+specifications = SacspGateway.step_1(subject_key)
+
+#2 - Envie a especificação do assunto com base na lista retornada pelo pelo step_1.
+specification_key = specifications.last[:key] #ex.: "200101STapa-buraco"
+response = SacspGateway.step_2(specification_key)
+
+#3 - Envia os dados do chamado, descrição rua, etc.
+#    O campo Logradouro, deve que ser especificado conforme no site.
+#    Ex:NÃO escreva Av. Brig. Faria Lima, escreva APENAS, Faria Lima, OU entre com o CEP sem hífen. Ex: 01452000.
+ticket_data = {
+  txtLogradouro: 'pouso alegre',
+  txtNumero: 01,
+  txtReferencia: 'na esquina c av nazare',
+  txtDescricao: 'A via possui um buraco bem na esquina com a av nazare.'
+}
+street_occurrences = SacspGateway.step_3(ticket_data)
+
+#3.1 - Confirma dados do endereço do chamado (com base na resposta do step_3.
+#      Se o nome da rua digitada existir em mais de uma localidade, o sistema exije que se selecione
+#      a qual dos endereços que a rua pertence (ex.: Rua Vergueiro existe em Santo Amaro, Liberdade e Vila Mariana).
+#      Eu sei que é estranho mas infelizmente o sistema da prefeitura funciona assim (pra não dizer que é uma merda).
+street_selected = street_occurrences.last[:key] # Ex.: '165590R   POUSO ALEGRE - VILA MONUMENTO'
+ticket_data = {
+  comboLogradouro: street_selected,
+  txtNumero: 01,
+  txtReferencia: 'na esquina c av nazare',
+  txtDescricao: 'A via possui um buraco bem na esquina com a av nazare.'
+}
+response = SacspGateway.step_3_1(ticket_data)
+
+
+#4 - Especifica os dados (RG, UF) de quem está abrindo o chamado (você?)
+id_info = {
+  txtRG: 112223334,
+  comboRGUF: 'SP'
+}
+response = SacspGateway.step_4(id_info)
+
+
+#5 - Finaliza o envio do chamado, passando os dados complementares do usuário do chamado
+citizen_data = {
+  comboRGUF: 'SP',
+  txtNome: 'Marcelo Cidadao',
+  txtLogradouro: 'Rua Joao Inacio',
+  txtNumero: 8424,
+  txtComplemento: '123, bl4',
+  txtCep: '01536001',
+  txtCidade: 'Sao Paulo',
+  comboUF: 'SP',
+  txtTelefone: '911111111',
+  txtFax: '',
+  txtCPF: '',
+  txtEmail: 'meuemail@gmail.com',
+  comboOcupacao: '002'
+}
+ticket_number = SacspGateway.step_5!(citizen_data)
+
+puts "Chamado criado com sucesso!!! --> #{ticket_number}"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gnumarcelo/sacsp_gateway.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sacsp_gateway"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sacsp_gateway.rb

@@ -0,0 +1,15 @@
+require "sacsp_gateway/version"
+require "sacsp_gateway/exception"
+require "sacsp_gateway/client"
+
+module SacspGateway
+  extend SingleForwardable
+
+  def_delegators :client, :get_subjects, :step_1, :step_2, :step_3,
+    :step_3_1, :step_4, :step_5!
+
+  def self.client
+    @client ||= Client.new
+  end
+
+end

data/lib/sacsp_gateway/client.rb

@@ -0,0 +1,91 @@
+require 'sacsp_gateway/connection'
+
+module SacspGateway
+  class Client
+
+    def conn
+      @conn ||= Connection.new
+    end
+
+    def get_subjects
+      #Busca todos os assuntos:
+      resp_doc = conn.get('/')
+      validate_field_presence(resp_doc, "comboAssunto")
+      assuntos = resp_doc.xpath('//*[@name="comboAssunto"]/option').map do |it|
+        {key: it.attr(:value), text: it.text }
+      end
+    end
+
+    def step_1 subject_key
+      #send_ticket_subject - Select the ticket subject
+      resp_doc = conn.post('/default.asp', {
+        txtAssu: '',
+        comboAssunto: subject_key,
+        acao2: 'Continuar'
+      })
+      validate_field_presence(resp_doc, "comboSubAssunto")
+      specification = resp_doc.xpath('//*[@name="comboSubAssunto"]/option').map do |it|
+        {key: it.attr(:value), text: it.text}
+      end
+    end
+
+    def step_2 specification_key
+      #send_ticket_subject_specification - Select the subject specification
+      resp_doc = conn.post('/solicitacaoCadastro.asp', {
+        comboSubAssunto: specification_key,
+        acao: 'Continuar'
+      })
+      validate_field_presence(resp_doc, "txtDescricao")
+      return true #TODO: deve mesmo retornar algo? true?
+    end
+
+    def step_3 ticket_data
+      #send_ticket_request_data
+      ticket_data.merge(acao: 'Continuar')
+      resp_doc = conn.post('/CadastroParametro/Logradouro.asp', ticket_data)
+      validate_field_presence(resp_doc, "comboLogradouro")
+      streets = resp_doc.xpath('//*[@name="comboLogradouro"]').map do |opt|
+        {key: opt.attr(:value), text: opt.attr(:value).split(" ", 2).last }
+      end
+    end
+
+    def step_3_1 ticket_data
+      #send_ticket_request_data_confirmation
+      ticket_data.merge(acao: 'Continuar')
+      resp_doc = conn.post('/CadastroParametro/Logradouro.asp', ticket_data)
+      validate_field_presence(resp_doc, "txtRG")
+      return true #TODO: deve mesmo retornar algo? true?
+    end
+
+    def step_4 id_info
+      #send_citizen_id_info
+      id_info.merge(acao: 'Continuar')
+      resp_doc = conn.post('/CadastroParametro/Logradouro.asp', id_info)
+      citizen_id = id_info[:txtRG]
+      validate_content_value_presence(resp_doc, "td", citizen_id)
+      return true #TODO: deve mesmo retornar algo? true?
+    end
+
+    def step_5! citizen_data
+      #send_citizen_data_confirmation
+      resp_doc = conn.post('/CadastroParametro/Solicitante.asp?Acao=ENVIAR', citizen_data)
+      ticket_number = resp_doc.xpath('//*[@id="conteudo2"]/table/tr/td/font/b').text
+      fail SacspGatewayException.new("Response is not the expected") if !ticket_number
+      ticket_number
+    end
+
+  private
+    def validate_field_presence resp_doc, attribute_name
+      if resp_doc.xpath("//*[@name='#{attribute_name}']").size == 0
+        fail SacspGatewayException.new("Response is not the expected")
+      end
+    end
+
+    def validate_content_value_presence resp_doc, node_name, value
+      if !resp_doc.at("#{node_name}:contains('#{value}')")
+        fail SacspGatewayException.new("Response is not the expected")
+      end
+    end
+  end
+end
+#https://github.com/brainspec/cloudmate/blob/c7004e45b10852e8ab4f44cfae8b98603301162f/lib/cloudmate/client.rb

data/lib/sacsp_gateway/connection.rb

@@ -0,0 +1,31 @@
+require 'faraday_middleware'
+require 'faraday-cookie_jar'
+require 'faraday'
+require 'nokogiri'
+
+module SacspGateway
+  class Connection
+    def initialize
+      @conn = Faraday.new(:url => 'http://sac.prefeitura.sp.gov.br') do |faraday|
+        faraday.request  :url_encoded
+        faraday.response :logger
+        faraday.use :cookie_jar
+        faraday.use FaradayMiddleware::FollowRedirects, limit: 3
+        faraday.use Faraday::Response::RaiseError # raise exceptions on 40x, 50x responses
+        faraday.adapter  Faraday.default_adapter
+      end
+      #@conn.headers[:user_agent] = 'SACSP::Gateway v0.0.1' # substituir versao aqui
+      @conn
+    end
+
+    def post(path, data)
+      response = @conn.post(path, data)
+      Nokogiri::HTML(response.body)
+    end
+
+    def get(path)
+      response = @conn.get(path)
+      doc = Nokogiri::HTML(response.body)
+    end
+  end
+end

data/lib/sacsp_gateway/exception.rb

@@ -0,0 +1,4 @@
+module SacspGateway
+  class SacspGatewayException < Exception
+  end
+end

data/lib/sacsp_gateway/version.rb

@@ -0,0 +1,3 @@
+module SacspGateway
+  VERSION = "0.1.0"
+end

data/sacsp_gateway.gemspec

@@ -0,0 +1,44 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sacsp_gateway/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sacsp_gateway"
+  spec.version       = SacspGateway::VERSION
+  spec.authors       = ["Marcelo Menezes"]
+  spec.email         = ["gnumarcelo@gmail.com"]
+
+  spec.summary       = %q{Criação de chamados no SAC da Prefeitura de São Paulo.}
+  spec.description   = %q{Gem EXPERIMENTAL para criação de chamados no SAC da Prefeitura de São Paulo.}
+  spec.homepage      = "https://github.com/gnumarcelo/sacsp_gateway"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.2'
+  spec.add_dependency 'mechanize'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday-cookie_jar'
+  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'nokogiri'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency 'vcr', '~> 2'
+  spec.add_development_dependency 'webmock'
+  #spec.add_development_dependency 'debugger'
+
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: sacsp_gateway
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcelo Menezes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  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-cookie_jar
+  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'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+description: Gem EXPERIMENTAL para criação de chamados no SAC da Prefeitura de São
+  Paulo.
+email:
+- gnumarcelo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sacsp_gateway.rb
+- lib/sacsp_gateway/client.rb
+- lib/sacsp_gateway/connection.rb
+- lib/sacsp_gateway/exception.rb
+- lib/sacsp_gateway/version.rb
+- sacsp_gateway.gemspec
+homepage: https://github.com/gnumarcelo/sacsp_gateway
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Criação de chamados no SAC da Prefeitura de São Paulo.
+test_files: []