fattura24 1.0.0

data/fattura24.gemspec

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fattura24/version'
+
+file_regex = /^(
+  \.env.example|
+  \.dockerignore|
+  \.gitignore|
+  \.rspec|
+  \.rubocop.yml|
+  \.ruby-version|
+  \.travis.yml|
+  \.codeclimate.yml|
+  Makefile|
+  Dockerfile\.|
+  test|
+  spec|
+  bin
+)/x
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fattura24'
+  spec.version       = Fattura24::VERSION
+  spec.authors       = ['Stefano Nada']
+  spec.email         = ['stefano.nada@gmail.com']
+
+  spec.summary       = 'Ruby wrapper for fattura24 apis'
+  spec.description   = 'Minimal Ruby 2 wrapper for fattura24 apis.'
+  spec.homepage      = 'https://github.com/snada/fattura24'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(file_regex)
+    end
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activesupport', '> 4.2'
+  spec.add_runtime_dependency 'builder'
+
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'dotenv', '~> 2.7'
+  spec.add_development_dependency 'pry', '~> 0.13'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rdoc', '~> 6.1'
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'rubocop', '~> 0.82'
+  spec.add_development_dependency 'simplecov', '~> 0.17.0'
+  spec.add_development_dependency 'webmock', '~> 3.8'
+end

data/lib/fattura24.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash'
+require 'active_support/core_ext/string'
+
+require 'fattura24/api/client'
+require 'fattura24/api/response'
+
+require 'fattura24/configuration'
+require 'fattura24/document_type'
+require 'fattura24/errors'
+require 'fattura24/utils'
+require 'fattura24/version'
+
+module Fattura24
+  ##
+  # Returns current configuration object
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  ##
+  # Calling this method will yield to a block
+  # passing the +configuration+ object as parameter.
+  def self.configure
+    yield configuration
+  end
+end

data/lib/fattura24/api/client.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module Fattura24
+  module Api
+    ##
+    # This library uses {fattura24.com}[https://fattura24.com] v0.3 apis.
+    # Check their docs {here}[https://www.fattura24.com/api-documentazione/].
+    API_HOST = 'https://www.app.fattura24.com/api/v0.3'
+
+    ##
+    # Performs a generic request on the api endpoint using Ruby's
+    # {Net::HTTP}[https://ruby-doc.org/stdlib-2.7.0/libdoc/net/http/rdoc/Net/HTTP.html].
+    # All the other api methods call this one.
+    # Parameter +path+ should always be prepended with '/'.
+    # Body will default to an empty hash.
+    # Returns a {Response}[rdoc-ref:Fattura24::Api::Response] object.
+    def self.request(path, body = {})
+      raise Fattura24::MissingApiKey unless Fattura24.configuration.api_key
+
+      uri = URI.parse("#{API_HOST}#{path}")
+      request = Net::HTTP::Post.new(uri)
+      request.set_form_data(inject_api_key(body))
+
+      req_options = { use_ssl: uri.scheme == 'https' }
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      Response.new(response)
+    end
+
+    ##
+    # Tests validity of your api key.
+    # Returns a {Response}[rdoc-ref:Fattura24::Api::Response] object.
+    def self.test_key
+      request('/TestKey')
+    end
+
+    # rubocop:disable Naming/AccessorMethodName
+
+    ##
+    # Gets a list of document templates.
+    # Returns a {Response}[rdoc-ref:Fattura24::Api::Response] object.
+    def self.get_template
+      request('/GetTemplate')
+    end
+
+    ##
+    # Gets 'piano dei conti'
+    # Returns a {Response}[rdoc-ref:Fattura24::Api::Response] object.
+    def self.get_pdc
+      request('/GetPdc')
+    end
+
+    ##
+    # Gets numerator list.
+    # Returns a {Response}[rdoc-ref:Fattura24::Api::Response] object.
+    def self.get_numerator
+      request('/GetNumerator')
+    end
+
+    ##
+    # Donwloads a pdf file for an existing document.
+    # Requires an existing document id, throws
+    # {MissingInput}[rdoc-ref:Fattura24::MissingInput] when passing a nil +id+.
+    # Returns a {Response}[rdoc-ref:Fattura24::Api::Response] object: refer
+    # to it's documentation to detect a binary file and instruction
+    # to save it to disk.
+    def self.get_file(id)
+      raise(Fattura24::MissingInput, 'You need to provide an id') unless id
+
+      request('/GetFile', { docId: id })
+    end
+
+    ##
+    # Gets a list of products.
+    # You can pass a Hash containing a +code+ or +category+
+    # to filter your existing products by them.
+    # Throws a
+    # {InvalidParams}[rdoc-ref:Fattura24::InvalidParams] when passing
+    # an hash containing unrecognized options.
+    # Returns a {Response}[rdoc-ref:Fattura24::Api::Response] object.
+    def self.get_product(options = {})
+      validate_params(options, %i[code category])
+      request('/GetProduct', options)
+    end
+
+    # rubocop:enable Naming/AccessorMethodName
+
+    ##
+    # Saves a customer in your contact list.
+    # Any +nil+ parameter will be deeply removed
+    # by using the {crush}[rdoc-ref:Fattura24::Utils.crush] utility.
+    # Returns a {Response}[rdoc-ref:Fattura24::Api::Response] object.
+    def self.save_customer(data = {})
+      request('/SaveCustomer', {
+        xml: hash_to_xml(data)
+      })
+    end
+
+    ##
+    # Use this to create documents. Pass a hash with the data, check
+    # the README file for examples. Use
+    # {DocumentType}[rdoc-ref:Fattura24::DocumentType]
+    # enums to specify document type.
+    # Any +nil+ parameter will be deeply removed
+    # by using the {crush}[rdoc-ref:Fattura24::Utils.crush] utility.
+    # Returns a {Response}[rdoc-ref:Fattura24::Api::Response] object.
+    def self.save_document(data = {})
+      request('/SaveDocument', {
+        xml: hash_to_xml(data)
+      })
+    end
+
+    ##
+    # Creates a credit.
+    # Any +nil+ parameter will be deeply removed
+    # by using the {crush}[rdoc-ref:Fattura24::Utils.crush] utility.
+    # Returns a {Response}[rdoc-ref:Fattura24::Api::Response] object.
+    def self.save_item(data = {})
+      request('/SaveItem', {
+        xml: hash_to_xml(data)
+      })
+    end
+
+    def self.hash_to_xml(hash)
+      { document: Fattura24::Utils.crush(hash) || '' }
+        .to_xml(
+          root: 'Fattura24',
+          indent: 0,
+          skip_types: true,
+          camelize: true
+        )
+    end
+
+    def self.inject_api_key(hash)
+      hash.merge(apiKey: Fattura24.configuration.api_key)
+    end
+
+    def self.validate_params(params, permitted_params)
+      invalid_params = params.keys.map(&:to_sym) - permitted_params
+
+      raise_params_error(invalid_params) if invalid_params.any?
+    end
+
+    def self.raise_params_error(invalid_params)
+      msg = "This params are not permitted: #{invalid_params.join(', ')}"
+      raise Fattura24::InvalidParams, msg
+    end
+
+    private_class_method(
+      :hash_to_xml,
+      :inject_api_key,
+      :validate_params,
+      :raise_params_error
+    )
+  end
+end

data/lib/fattura24/api/response.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Fattura24
+  module Api
+    ##
+    # An instance of this class will be returned on every
+    # api call, wrapping the content of the response and
+    # providing helper methods to navigate it's content.
+    class Response
+      ##
+      # When needed, you can directly access the underlying
+      # {Net::HTTP}[https://ruby-doc.org/stdlib-2.7.0/libdoc/net/http/rdoc/Net/HTTP.html] response
+      # by calling this method.
+      attr_reader :http_response
+
+      def initialize(http_response)
+        @http_response = http_response
+      end
+
+      ##
+      # Returns +true+ when the http response
+      # is 200, +false+ otherwise.
+      def success?
+        code == 200
+      end
+
+      ##
+      # Returns the +Integer+ value of the underlying http request.
+      # It does not mean the request performed it's intended purpose.
+      # Make sure you use {to_s}[rdoc-ref:to_s] or {to_h}[rdoc-ref:to_h]
+      # to explore the actual body of the response.
+      def code
+        http_response&.code.to_i
+      end
+
+      ##
+      # Returns +true+ when the body of the request contains a pdf file.
+      def pdf?
+        http_response&.content_type&.underscore == 'application/pdf'
+      end
+
+      ##
+      # Returns an hash representation of the xml body of the response.
+      # Raises {NotSerializable}[rdoc-ref:Fattura24::NotSerializable]
+      # in case of a binary (pdf file) content.
+      def to_h
+        if pdf?
+          raise(
+            Fattura24::NotSerializable,
+            'Cannot create hash from binary file'
+          )
+        end
+
+        Hash.from_xml(http_response&.body)
+          &.deep_transform_keys do |key|
+            key.to_s.underscore.to_sym
+          end
+      end
+
+      ##
+      # Returns the +String+ body of this response.
+      # This can be both the original xml on most of the calls
+      # or the content of the pdf file when {get_file}[rdoc-ref:get_file]
+      # is called.
+      def to_s
+        http_response&.body.to_s
+      end
+    end
+  end
+end

data/lib/fattura24/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Fattura24
+  class Configuration
+    ##
+    # Set this attribute to your secret
+    # api key to interact with the api
+    attr_accessor :api_key
+
+    def initialize
+      @api_key = nil
+    end
+  end
+end

data/lib/fattura24/document_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Fattura24
+  ##
+  # This module contains constants to be used
+  # when creating documents/credits.
+
+  module DocumentType
+    ELECTRONIC_INVOICE = 'FE'
+    INVOICE = 'I'
+    RECEIPT = 'R'
+    CLIENT_ORDER = 'C'
+    CREDIT_NOTE = 'N'
+  end
+end

data/lib/fattura24/errors.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Fattura24
+  class Error < RuntimeError; end
+
+  ##
+  # Thrown when trying to perform any request
+  # on the api without a key set in configuration
+  class MissingApiKey < Error
+    def message
+      'You need to configure your api key before calling any endpoint'
+    end
+  end
+
+  class MissingInput < Error; end
+
+  class NotSerializable < Error; end
+
+  class InvalidParams < Error; end
+end

data/lib/fattura24/utils.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Fattura24
+  module Utils
+    ##
+    # This function deeply removes
+    # any nil object/value from objects.
+    def self.crush(obj)
+      return crush_hash(obj) if obj.is_a?(Hash)
+
+      return crush_array(obj) if obj.is_a?(Array)
+
+      obj
+    end
+
+    ##
+    # Deeply removes any nil value from arrays.
+    def self.crush_array(array)
+      r = array.map do |obj|
+        crush(obj)
+      end.compact
+
+      r.empty? ? nil : r
+    end
+
+    ##
+    # Deeply removes any nil value from hashes.
+    def self.crush_hash(hash)
+      r = hash.each_with_object({}) do |(k, v), h|
+        if (crushed_v = crush(v))
+          h[k] = crushed_v
+        end
+      end
+
+      r.empty? ? nil : r
+    end
+  end
+end

data/lib/fattura24/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Fattura24
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,267 @@
+--- !ruby/object:Gem::Specification
+name: fattura24
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Stefano Nada
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: builder
+  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.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.82'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.82'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !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: Minimal Ruby 2 wrapper for fattura24 apis.
+email:
+- stefano.nada@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- docs/Fattura24.html
+- docs/Fattura24/Api.html
+- docs/Fattura24/Api/Response.html
+- docs/Fattura24/Configuration.html
+- docs/Fattura24/DocumentType.html
+- docs/Fattura24/Error.html
+- docs/Fattura24/InvalidParams.html
+- docs/Fattura24/MissingApiKey.html
+- docs/Fattura24/MissingInput.html
+- docs/Fattura24/NotSerializable.html
+- docs/Fattura24/Utils.html
+- docs/README_md.html
+- docs/created.rid
+- docs/css/fonts.css
+- docs/css/rdoc.css
+- docs/fonts/Lato-Light.ttf
+- docs/fonts/Lato-LightItalic.ttf
+- docs/fonts/Lato-Regular.ttf
+- docs/fonts/Lato-RegularItalic.ttf
+- docs/fonts/SourceCodePro-Bold.ttf
+- docs/fonts/SourceCodePro-Regular.ttf
+- docs/images/add.png
+- docs/images/arrow_up.png
+- docs/images/brick.png
+- docs/images/brick_link.png
+- docs/images/bug.png
+- docs/images/bullet_black.png
+- docs/images/bullet_toggle_minus.png
+- docs/images/bullet_toggle_plus.png
+- docs/images/date.png
+- docs/images/delete.png
+- docs/images/find.png
+- docs/images/loadingAnimation.gif
+- docs/images/macFFBgHack.png
+- docs/images/package.png
+- docs/images/page_green.png
+- docs/images/page_white_text.png
+- docs/images/page_white_width.png
+- docs/images/plugin.png
+- docs/images/ruby.png
+- docs/images/tag_blue.png
+- docs/images/tag_green.png
+- docs/images/transparent.png
+- docs/images/wrench.png
+- docs/images/wrench_orange.png
+- docs/images/zoom.png
+- docs/index.html
+- docs/js/darkfish.js
+- docs/js/navigation.js
+- docs/js/navigation.js.gz
+- docs/js/search.js
+- docs/js/search_index.js
+- docs/js/search_index.js.gz
+- docs/js/searcher.js
+- docs/js/searcher.js.gz
+- docs/table_of_contents.html
+- fattura24.gemspec
+- lib/fattura24.rb
+- lib/fattura24/api/client.rb
+- lib/fattura24/api/response.rb
+- lib/fattura24/configuration.rb
+- lib/fattura24/document_type.rb
+- lib/fattura24/errors.rb
+- lib/fattura24/utils.rb
+- lib/fattura24/version.rb
+homepage: https://github.com/snada/fattura24
+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.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for fattura24 apis
+test_files: []