quaderno 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87cd629b645c9dccf37590027c38d2f32582e4ecb5f746882a9e4c5e8dce951b
-  data.tar.gz: 5b3f2271733c94ba33a0968c647c221a1ae35fe972b85eba28bfda2e847baf4e
+  metadata.gz: a9b1cc29c32e037177c8c590bf7aeec9712e6313445aa7e496584a56e773764f
+  data.tar.gz: cf3ff48c4eb21de4f6669f4cb69350c2d8393f6318ea15899a559c5d865a711b
 SHA512:
-  metadata.gz: 680f294a15ab5efc78d7457de2ad43ff26df3cfb719ff9d5ddfc19d23832488eb7e624092dff185414aa6867a8e142a3b03c21d35808c736d7c93fdc2418c3a5
-  data.tar.gz: af06b1277320b63e3df52dd9be2984d61ce17c1418c4e31b68ba91349ad76f7b59e0428e0e697daf9f7569811d892ab4ff7bf8756b25a08fe41635c4883dad0d
+  metadata.gz: ce39d849088fe2d0203af6cb46f2d1af55b9ea364be9cc72f28ae5276426352a0b8c2f6c1e5433e5af6afa5997e1b10d61b9c7721629ed69bc11e03cefbebcfb
+  data.tar.gz: d822575449a512681d494565381beb6e5bb50f5ef6b680d3b3d2c7e90c86e84d1d747026c915398bae87c3244eeeca4c57ed3a7983a6774a104dca0a443b85ca

data/.github/workflows/test.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec ./spec/**/*.rb

data/README.md

@@ -2,7 +2,7 @@
 
 Quaderno-ruby is a ruby wrapper for [Quaderno API] (https://github.com/quaderno/quaderno-api).
 
-Current version is 2.0.1 See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
+Current version is 2.1.0 See the changelog [here](https://github.com/quaderno/quaderno-ruby/blob/master/changelog.md)
 
 ## Installation & Configuration
 
@@ -19,6 +19,7 @@ To configure just add this to your initializers
     config.auth_token = 'my_authenticate_token'
     config.url = 'https://my_subdomain.quadernoapp.com/api/'
     config.api_version = API_VERSION # Optional, defaults to the API version set in your account
+    config.user_agent_header = 'my custom user agent' # Optional, will make support for your account more efficient if you are doing oauth integrations
   end
 ```
 
@@ -584,6 +585,29 @@ will update the specified checkout session with the data of the hash passed as s
 ```
 will delete the checkout session with the id passed as parameter. If the deletion was successful, an instance of `Quaderno::CheckoutSession` with the `deleted` attribute set to `true` will be returned.
 
+## Managing report requests
+
+### Getting report requests
+```ruby
+  Quaderno::ReportRequest.all #=> Array
+```
+
+ will return an array with all your report requests.
+
+### Finding a report request
+```ruby
+  Quaderno::ReportRequest.find(id) #=> Quaderno::ReportRequest
+```
+
+will return the report request with the id passed as parameter.
+
+### Creating a new report request
+
+```ruby
+  Quaderno::ReportRequest.create(params) #=> Quaderno::ReportRequest
+```
+
+will create a report request using the information of the hash passed as parameter and return an instance of Quaderno::ReportRequest with the created report request.
 
 ## Exceptions
 Quaderno-ruby exceptions raise depending on the type of error:
@@ -603,6 +627,7 @@ Quaderno-ruby exceptions raise depending on the type of error:
 
   Quaderno::Exceptions::RequiredFieldsEmptyOrInvalid # Raised if the format of the request is right but some validations failed. You can JSON parse the exception message to get which field triggered the exception. For example: '{"errors":{"vat_number":["is not a valid German vat number"]}}'
 
+  Quaderno::Exceptions::ServerError # Raised when Quaderno returns an HTTP response code of the 50X family. Try again later or contact support if the issue persists
 ```
 
 All those exceptions inherit from `Quaderno::Exceptions::BaseException`.
@@ -614,7 +639,7 @@ Whenever you call the `all` method on one of the classes, the result will be a `
 collection = Quaderno::Contact.all
 
 collection.class #=> Quaderno::Collection
-collection.has_next? #=> true
+collection.has_more? #=> true
 collection.next_page #=> another instance of
 ```
 

data/changelog.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.1.0
+* Added a new `Quaderno::Exceptions::ServerError` exception for more transparency, and better control of workflows
+* Added a `user_agent_header` optional configuration to make debugging oauth integrations easier
+
 ## 2.0.2
 * Fix an issue with the parameters sent during the `validate_vat_number` request
 * Renames `validate_vat_number` into `validate_tax_id`

data/lib/quaderno-ruby/base.rb

@@ -15,6 +15,7 @@ class Quaderno::Base < OpenStruct
   @@rate_limit_info = nil
   @@api_version = nil
   @@url = PRODUCTION_URL
+  @@user_agent_suffix = nil
 
   # Class methods
   def self.api_model(klass)
@@ -56,6 +57,8 @@ class Quaderno::Base < OpenStruct
       data.rate_limit_info = response
 
       data
+    elsif response.response.is_a?(Net::HTTPServerError)
+      raise_exception(Quaderno::Exceptions::ServerError, 'Server error', response)
     else
       raise_exception(Quaderno::Exceptions::InvalidSubdomainOrToken, 'Invalid subdomain or token', response)
     end
@@ -140,7 +143,7 @@ class Quaderno::Base < OpenStruct
   end
 
   def self.user_agent_header
-    { "User-Agent" => "Quaderno Ruby Gem #{Quaderno::VERSION}" }
+    @_user_agent_header ||= { "User-Agent" => ["Quaderno Ruby Gem #{Quaderno::VERSION}", @@user_agent_suffix].compact.join(' - ') }
   end
 
   def self.version_header

data/lib/quaderno-ruby/exceptions/exceptions.rb

@@ -24,6 +24,9 @@ module Quaderno::Exceptions
   class UnsupportedApiVersion < BaseException
   end
 
+  class ServerError < BaseException
+  end
+
   def self.included(receiver)
     receiver.send :extend, ClassMethods
   end
@@ -50,6 +53,8 @@ module Quaderno::Exceptions
       if params[:has_documents].nil? == false
         raise_exception(Quaderno::Exceptions::HasAssociatedDocuments, party_response.body, party_response) if party_response.response.class == Net::HTTPClientError
       end
+
+      raise_exception(Quaderno::Exceptions::ServerError, 'Server error', response) if party_response.response.is_a?(Net::HTTPServerError)
     end
 
     def raise_exception(klass, message, response)

data/lib/quaderno-ruby/report_request.rb

@@ -0,0 +1,4 @@
+class Quaderno::ReportRequest < Quaderno::Base
+  api_model Quaderno::ReportRequest
+  api_path 'reporting/requests'
+end

data/lib/quaderno-ruby/version.rb

@@ -1,3 +1,3 @@
 class Quaderno
-  VERSION = "2.0.2"
+  VERSION = "2.1.0"
 end

data/lib/quaderno-ruby.rb

@@ -10,4 +10,4 @@ require 'quaderno-ruby/helpers/authentication'
 require 'quaderno-ruby/collection'
 
 %w(block crud deliver payment retrieve).each { |filename| require "quaderno-ruby/behavior/#{filename}" }
-%w(base contact item invoice receipt credit income estimate expense recurring document_item report evidence payment webhook tax checkout_session).each { |filename| require "quaderno-ruby/#{ filename }" }
+%w(base contact item invoice receipt credit income estimate expense recurring document_item report report_request evidence payment webhook tax checkout_session).each { |filename| require "quaderno-ruby/#{ filename }" }

data/quaderno.gemspec

@@ -4,30 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'quaderno-ruby/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "quaderno"
+  spec.name = 'quaderno'
   spec.version = Quaderno::VERSION
-  spec.authors = ["Recrea"]
-  spec.email = "carlos@recrea.es"
+  spec.authors = ['Recrea']
+  spec.email = 'carlos@recrea.es'
 
-  spec.summary = "Ruby wrapper for the Quaderno API (https://quaderno.io/docs/api)"
-  spec.description = " A ruby wrapper for Quaderno API "
-  spec.homepage = "http://github.com/quaderno/quaderno-ruby"
-  spec.licenses = ["MIT"]
+  spec.summary = 'Ruby wrapper for the Quaderno API (https://quaderno.io/docs/api)'
+  spec.description = ' A ruby wrapper for Quaderno API '
+  spec.homepage = 'http://github.com/quaderno/quaderno-ruby'
+  spec.licenses = ['MIT']
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = %w(lib)
-  spec.date = "2018-05-07"
+  spec.date = '2018-05-07'
   spec.extra_rdoc_files = %w(LICENSE.txt README.md)
 
-
-  spec.add_dependency('httparty', "~> 0.13")
-  spec.add_development_dependency('rdoc', "~> 3.12")
-  spec.add_development_dependency('activesupport', "~> 4.2.0")
-  spec.add_development_dependency('webmock', "~> 1.22.6")
-  spec.add_development_dependency('vcr', ">= 0")
-  spec.add_development_dependency("bundler", "~> 2.2")
-  spec.add_development_dependency("rake", ">= 12.3.3")
-  spec.add_development_dependency("rspec", "~> 3.0")
+  spec.add_dependency('httparty', '~> 0.13')
+  spec.add_development_dependency('rdoc', '>= 6.3.1')
+  spec.add_development_dependency('activesupport', '~> 4.2.0')
+  spec.add_development_dependency('webmock', '~> 1.22.6')
+  spec.add_development_dependency('vcr', '>= 0')
+  spec.add_development_dependency('bundler', '~> 2.2')
+  spec.add_development_dependency('rake', '>= 12.3.3')
+  spec.add_development_dependency('rspec', '~> 3.0')
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quaderno
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Recrea
@@ -28,16 +28,16 @@ dependencies:
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 6.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: 6.3.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -131,9 +131,9 @@ extra_rdoc_files:
 - README.md
 files:
 - ".document"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -164,6 +164,7 @@ files:
 - lib/quaderno-ruby/receipt.rb
 - lib/quaderno-ruby/recurring.rb
 - lib/quaderno-ruby/report.rb
+- lib/quaderno-ruby/report_request.rb
 - lib/quaderno-ruby/tax.rb
 - lib/quaderno-ruby/version.rb
 - lib/quaderno-ruby/webhook.rb
@@ -187,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Ruby wrapper for the Quaderno API (https://quaderno.io/docs/api)

data/.travis.yml

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