efatura 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 53e8a8605e0ccc4c7ed733b9a29655791400c6e9d3b218afeb42c97e55dc5a66
+  data.tar.gz: ee8ec12924530c73625d8387492675e0ccf619a48442c75ea028ffb144d7346c
+SHA512:
+  metadata.gz: 82df9166df5bf58e8f6ebc42856d647c4eb8680fbee5049de49659f13c561808493497dc2ea272f3ace16e313949e89a9e7261af22e350bb118ebccec31e44de
+  data.tar.gz: e24c003fc7b7e9489f05a7d83bef26dac7e1549704ad69d75c2c5271741fb0255c675c92a926f39402450e119d984ff579b250452ee9fb86a9b1c1c7fe228d1e

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at filipe.l.custodio@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 filipe custodio
+
+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,95 @@
+# Efatura Gem
+
+Efatura is a portuguese finance/tax website that you can visit at https://faturas.portaldasfinancas.gov.pt/
+
+Currently Efatura doesn't provide a basic REST Api for GET Requests in order to retrieve your personal invoice information during a certain period.
+
+So this is where Efatura Gem comes in.
+
+Efatura website data is populated via AJAX Requests. This gem uses mechanize in order to login to efatura from the backend and intercept the jsons that are being used by AJAX.
+
+This gem is 100% Open sourced and no sensitive information is saved whatsoever so you can use it without any concern.
+
+Feel feel to contribute to it or report any bugs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'efatura'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install efatura
+
+## How to use - Step by Step
+
+1- Configuration
+
+Start by configurating the Gem.
+
+  For that you should do:
+
+    Efatura.configuration.nif = 'your nif'
+    Efatura.configuration.password = 'your password'
+
+  Be sure that you set both configurations as strings.
+
+  You can check if the values are set by doing:
+
+    Efatura.configuration
+
+  This should return an object of Efatura with nif and password set
+
+  Also this gem comes with reset options for configuration. If you wish to reset the nif and password you should do:
+
+    Efatura.reset
+
+  And that's it. if you type:
+
+    Efatura.configuration => you'll see that nif and password are set as nil again.
+
+
+2- Fetching the invoices
+
+After doing the configuration you are now able to retrieve the invoices between 2 date periods.
+
+  In order to do this type:
+
+    Efatura.invoices(from_date, to_date)
+
+  Make sure that you pass both arguments as strings and also with the correct date format. YEAR-MONTH-DATE example: '2017-01-01'
+
+  If you type the wrong format or wrong date you won't be able to retrieve any information. Also since we are sending a request to an efatura backend there's some validations that we can't avoid. So far i've detected that in order for the gem to retrieve the invoices both dates should be in the same YEAR!
+
+  This is very important as it will not work if you send 
+
+    Efatura.invoices('2017-01-02', '2018-12-02')
+
+
+And that's pretty much it. Hope you enjoy!
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/fcustodio90/efatura. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Efatura project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fcustodio90/efatura/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'efatura'
+
+# 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

data/bin/setup

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

data/efatura.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'efatura/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'efatura'
+  spec.version       = Efatura::VERSION
+  spec.authors       = ['filipe custodio']
+  spec.email         = ['filipe.l.custodio@gmail.com']
+
+  spec.summary       = %q{Scraper for efatura PT website}
+  spec.description   = %q{efatura gem uses mechanize in order to login from the backend to efatura website to retrieve invoice information}
+  spec.homepage      = "https://github.com/fcustodio90/efatura"
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mechanize'
+  spec.add_dependency 'rest-client'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry-byebug'
+end

data/lib/efatura.rb

@@ -0,0 +1,32 @@
+require 'efatura/version'
+require 'efatura/configuration'
+require 'efatura/client'
+
+module Efatura
+  require 'mechanize'
+  require 'rest-client'
+  require 'date'
+  require 'json'
+  # EFATURA SCRAPER GEM. IT USES MECHANIZE TO SIMULATE A LOGIN TO EFATURA WEBSITE
+  # IT THEN REDIRECTS TO CONSUMIDOR PAGE IN ORDER TO FETCH THE NECESSARY COOKIES
+  # TO BUILD A REST-CLIENT REQUEST WITH COOKIES AS HEADERS
+  # EFATURA WEBSITE IS POPULATED WITH AJAX REQUESTS
+  # SO THE GOAL IS FETCH THE SAME JSONS THEY USE TO FEED DATA TO THE WEBSITE
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.invoices(from_date, to_date)
+    client = Client.new(from_date, to_date)
+    Client.new(from_date, to_date).invoices if client.date_valid?(from_date, to_date)
+  end
+end

data/lib/efatura/client.rb

@@ -0,0 +1,79 @@
+module Efatura
+  class Client
+    attr_accessor :from_date, :to_date
+    attr_accessor :cookies
+
+    LOGIN_URL = 'https://www.acesso.gov.pt/jsp/loginRedirectForm.jsp?path=painelAdquirente.action&partID=EFPF'
+    CONSUMIDOR_URL = 'https://faturas.portaldasfinancas.gov.pt/painelAdquirente.action'
+    FATURAS_URL = 'https://faturas.portaldasfinancas.gov.pt/json/obterDocumentosAdquirente.action'
+
+    def initialize(from_date, to_date)
+      @from_date = from_date
+      @to_date = to_date
+    end
+
+    def invoices
+      login
+      response = RestClient::Request.execute(
+        method: :get,
+        url: FATURAS_URL,
+        cookies: cookies,
+        headers: {
+          params: {
+            'dataInicioFilter' => from_date,
+            'dataFimFilter' => to_date,
+            'ambitoAquisicaoFilter' => 'TODOS'
+          }
+        }
+      )
+      JSON.parse(response)
+    end
+
+    def date_valid?(from_date, to_date)
+      # FOR A DATE TO BE VALID IT NEEDS TO PASS THE THREE CONDITIONS
+      date_format_valid?(from_date) && date_format_valid?(to_date) && date_same_year?(from_date, to_date)
+    end
+
+    def date_format_valid?(date)
+      # RECEIVE A DATE INSTANCE VARIABLE AND VERIFIES THE CORRECT FORMAT
+      format = '%Y-%m-%d'
+      DateTime.strptime(date, format)
+      true
+    rescue ArgumentError
+      false
+    end
+
+    def date_same_year?(from_date, to_date)
+      Date.parse(from_date).year == Date.parse(to_date).year
+    end
+
+    private
+
+    def login
+      # SET AN EMPTY HASH TO FEED LATER WITH AGENT COOKIE JAR
+      @cookies = {}
+      # INITIATE A NEW MECHANIZE INSTANCE
+      agent = Mechanize.new
+      # FETCH THE LOGIN URL AND ITERATES THRO LOGIN_PAGE IN ORDER TO TARGET HTML COMPONENTS
+      agent.get(LOGIN_URL) do |login_page|
+        # FETCHES THE LOGIN FORM FROM THE LOGIN PAGE
+        login_form = login_page.form_with(name: 'loginForm')
+        # SETS THE LOGIN USERNAME AKA NIF / NUMERO CONTRIBUINTE
+        login_form.username = Efatura.configuration.nif
+        # SETS THE LOGIN PASSWORD
+        login_form.password = Efatura.configuration.password
+        # SUBMITS THE FORM / LOGIN
+        agent.submit(login_form)
+        # AFTER A SUCCESSFUL LOGIN FETCH THE CONSUMIDOR PAGE IN ORDER TO RETRIEVE COOKIES
+        consumidor_page = agent.get(CONSUMIDOR_URL)
+        # ASSIGN THE CONSUMIDOR FORM TO A VARIABLE
+        consumidor_form = consumidor_page.form_with(name: 'form')
+        # SUBMIT THE FORM
+        agent.submit(consumidor_form)
+        # MAPS THE COOKIE_JAR FROM AGENT OBJECT AND FEEDS IT TO THE COOKIES HASH
+        # THAT WAS INITIALIZED WITH AN EMPTY HASH
+        @cookies = Hash[agent.cookie_jar.store.map { |i| i.cookie_value.split('=') }]
+      end
+    end
+  end
+end

data/lib/efatura/configuration.rb

@@ -0,0 +1,11 @@
+module Efatura
+  class Configuration
+    attr_accessor :nif, :password
+    # SET THE CONFIGURATION INITIALIZER WITH NIL VALUES SINCE THIS INFORMATION
+    # WILL COME FROM THE GEM USER
+    def initialize
+      @nif = nil
+      @password = nil
+    end
+  end
+end

data/lib/efatura/version.rb

@@ -0,0 +1,3 @@
+module Efatura
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: efatura
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- filipe custodio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-05 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: rest-client
+  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: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: pry-byebug
+  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: efatura gem uses mechanize in order to login from the backend to efatura
+  website to retrieve invoice information
+email:
+- filipe.l.custodio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- efatura.gemspec
+- lib/efatura.rb
+- lib/efatura/client.rb
+- lib/efatura/configuration.rb
+- lib/efatura/version.rb
+homepage: https://github.com/fcustodio90/efatura
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Scraper for efatura PT website
+test_files: []