nfeiow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f074d0b7b0471ab754f49546cdbc32418924146759c678cdaabde4456004d788
+  data.tar.gz: 91094265d28c7a1a08c1a9d4994256435da021bf97251efe83bbec8416fe8783
+SHA512:
+  metadata.gz: 53715342844b35989e854ccb7ff0092766e84e0545f505d4ff02dbc85214fba03fec18a30dfe590846470e54cc771e36a26e81aefe7617d0d62a88038f9315ea
+  data.tar.gz: 39ecab0fc76b778f88d108c9e631a8cfde1749946482cf66d6cc4db3eb77bdcaecfaa2c5f3f5b78cbab41fad4e32652cd0cfb0604365c1ffe425bbcdb13b23b6

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6.2
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.1
+        bundle install
+        bundle exec rspec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+    - single_quotes
+    - double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nfeiow.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 0.80"

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    nfeiow (0.1.0)
+      excon (>= 0.73.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    backport (1.1.2)
+    benchmark (0.1.1)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    e2mmap (0.1.0)
+    excon (0.78.1)
+    hashdiff (1.0.1)
+    jaro_winkler (1.5.4)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    method_source (1.0.0)
+    mini_portile2 (2.5.0)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    nokogiri (1.11.1-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    racc (1.5.2)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    reverse_markdown (2.0.0)
+      nokogiri
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    solargraph (0.40.3)
+      backport (~> 1.1)
+      benchmark
+      bundler (>= 1.17.2)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.1.0)
+    tilt (2.0.10)
+    unicode-display_width (1.7.0)
+    vcr (5.1.0)
+    webmock (3.11.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.26)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-20
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  nfeiow!
+  pry (~> 0.13.1)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.80)
+  solargraph (~> 0.40)
+  vcr (~> 5.1)
+  webmock (~> 3.8)
+
+BUNDLED WITH
+   2.2.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Anchieta Júnior
+
+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,86 @@
+# Nfeiow
+
+[NFE.io](https://nfe.io) wrapper to create, cancel, download (pdf) and send invoices via email.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nfeiow'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nfeiow
+
+## Usage
+
+### Initialize
+
+```rb
+client = Nfeiow::Client.new(company_id, api_key)
+```
+
+### Connection details
+
+```rb
+client.connection
+```
+
+### Create invoice - [Api Reference](https://nfe.io/docs/desenvolvedores/rest-api/nota-fiscal-de-servico-v1/#/ServiceInvoices/ServiceInvoices_Post)
+
+```rb
+params = {
+    borrower: {
+        federalTaxNumber: '65043222018', # Only numbers
+        name: 'José Anchieta',
+        email: 'anchieta@jose.com',
+        address: {
+        country: 'BRA',
+        postalCode: '86055620', # Only numbers
+        street: 'Rua Ulrico Zuinglio',
+        number: '870',
+        additionalInformation: 'Apto. 550',
+        district: 'Gleba Palhano',
+        city: {
+            code: 4113700,
+            name: 'Londrina'
+        },
+        state: 'PR'
+        }
+    },
+    cityServiceCode: '8599699',
+    cnaeCode: '8599699',
+    description: 'Cursos online.',
+    servicesAmount: 99.9
+}
+
+client.create_invoice(params)
+```
+
+### Cancel invoice - [Api Reference](https://nfe.io/docs/desenvolvedores/rest-api/nota-fiscal-de-servico-v1/#/ServiceInvoices/ServiceInvoices_Delete)
+
+```rb
+client.cancel_invoice(invoice_id)
+```
+
+### Download invoice (pdf) - [Api Reference](https://nfe.io/docs/desenvolvedores/rest-api/nota-fiscal-de-servico-v1/#/ServiceInvoices/ServiceInvoices_GetDocumentPdf)
+
+```rb
+client.download_invoice_pdf(invoice_id)
+```
+
+### Send invoice by email - [Api Reference](https://nfe.io/docs/desenvolvedores/rest-api/nota-fiscal-de-servico-v1/#/ServiceInvoices/ServiceInvoices_SendEmail)
+
+```rb
+client.send_invoice_via_email(invoice_id)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "nfeiow"
+
+# 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(__FILE__)

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/lib/nfeiow.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'nfeiow/version'
+require_relative 'nfeiow/helpers'
+require_relative 'nfeiow/client'
+
+module Nfeiow
+  module_function
+end

data/lib/nfeiow/client.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'pry'
+
+module Nfeiow
+  class Client
+    include Nfeiow::Helpers
+
+    attr_reader :company_id, :api_key
+
+    def initialize(company_id, api_key)
+      @company_id = company_id
+      @api_key = api_key
+    end
+
+    def connection
+      @connection ||= Excon.new(
+        'https://api.nfe.io/'
+      )
+    end
+
+    def create_invoice(params)
+      safe_http_call do
+        connection.post(
+          path: "/v1/companies/#{company_id}/serviceinvoices",
+          headers: headers,
+          body: params.to_json
+        )
+      end
+    end
+
+    def cancel_invoice(invoice_id)
+      safe_http_call do
+        connection.delete(
+          path: "/v1/companies/#{company_id}/serviceinvoices/#{invoice_id}",
+          headers: headers
+        )
+      end
+    end
+
+    def download_invoice_pdf(invoice_id)
+      safe_http_call(true) do
+        connection.get(
+          path: "/v1/companies/#{company_id}/serviceinvoices/#{invoice_id}/pdf",
+          headers: headers
+        )
+      end
+    end
+
+    def send_invoice_via_email(invoice_id)
+      safe_http_call do
+        connection.put(
+          path: "/v1/companies/#{company_id}/serviceinvoices/#{invoice_id}/sendemail",
+          headers: headers
+        )
+      end
+    end
+
+    private
+
+    def safe_http_call(download=false)
+      response = yield
+    
+      raise response.body unless success_http_status(response.status)
+
+      result(
+        true,
+        nil, 
+        download ? response.headers['Location'] : parse_payload(response.body)
+      )
+    rescue StandardError => e
+      result(false, e.message, nil)
+    end
+
+    def parse_payload(body)
+      return "Executed" if body == ""
+      JSON.parse(body)
+    end
+
+    def success_http_status(status)
+      [200, 201, 202, 302].include?(status)
+    end
+  end
+end

data/lib/nfeiow/helpers.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Nfeiow
+  module Helpers
+    RequestResut = Struct.new(:success?, :error, :value)
+
+    def headers
+      {
+        "Content-Type": 'application/json',
+        'Accept': 'application/json',
+        'Authorization': api_key
+      }
+    end
+
+    def result(success, error, value)
+      RequestResut.new(success, error, value)
+    end
+  end
+end

data/lib/nfeiow/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Nfeiow
+  VERSION = "0.1.0"
+end

data/nfeiow.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/nfeiow/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nfeiow"
+  spec.version       = Nfeiow::VERSION
+  spec.authors       = ["Instituto Padre Pio"]
+  spec.email         = ["padrepauloricardo@padrepauloricardo.org"]
+
+  spec.summary       = "A simple wrapper of the NFE io API"
+  spec.description   = "A simple wrapper of the NFE io API"
+  spec.homepage      = "https://github.com/institutopadrepio/nfeiow"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/institutopadrepio/nfeiow"
+  spec.metadata["changelog_uri"] = "https://github.com/institutopadrepio/nfeiow"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "excon", ">= 0.73.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "pry", "~> 0.13.1"
+  spec.add_development_dependency "rake",    "~> 12.3.3"
+  spec.add_development_dependency "rspec",   "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.7"
+  spec.add_development_dependency "solargraph", "~> 0.40"
+  spec.add_development_dependency "vcr",     "~> 5.1"
+  spec.add_development_dependency "webmock", "~> 3.8"
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: nfeiow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Instituto Padre Pio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.73.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.73.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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.40'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: A simple wrapper of the NFE io API
+email:
+- padrepauloricardo@padrepauloricardo.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nfeiow.rb
+- lib/nfeiow/client.rb
+- lib/nfeiow/helpers.rb
+- lib/nfeiow/version.rb
+- nfeiow.gemspec
+homepage: https://github.com/institutopadrepio/nfeiow
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/institutopadrepio/nfeiow
+  source_code_uri: https://github.com/institutopadrepio/nfeiow
+  changelog_uri: https://github.com/institutopadrepio/nfeiow
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple wrapper of the NFE io API
+test_files: []