elmas 2.4.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90fb105de4c3f2aa77e6f7b3626dd5094321830e
-  data.tar.gz: 17e8a3283657ecf5b2719149513de9006397f654
+  metadata.gz: c3beb2738aa3a94532e1e4f032a229f87e94aa08
+  data.tar.gz: 37ecf10dae1c0baf831cd221f15c900959d7137b
 SHA512:
-  metadata.gz: 47063de22815164f663e759576a0ed8555d07ce3f886f7292fa75d5ee1cb248233cc7b8815a4bde0f26acc1c55cba74b987740abcee1cb58d33ad3ea983552df
-  data.tar.gz: 827676a146a9ad6d76f3d8484a6c4d299e7f548079c955a8588987b29a4441c2117f2e509a10cf38a26af4cd387ebb0956b2cd052b997c074d7eecfdf850047f
+  metadata.gz: cb404ddad916430568cc25e593d52b06b0e8e35c4b211c78a8587e866c12e8de69b9ff5bee4f2a73659e49c274159cc034c12083592ab7cf146567be1ba3af1c
+  data.tar.gz: 299d31e087f5f2c7847e99cf81cde26e47db46c589216bed196177e75e6e884b69b53a4ea36435897b59d4a69fd3ef0935e523c8d0906cc72580670c1a531f36

data/.rubocop.yml

@@ -1,6 +1,15 @@
 Documentation:
   Enabled: false
 
+Lint/UriEscapeUnescape:
+  Enabled: false
+
+NAming/FileName:
+  Enabled: false
+
+Style/MethodMissing:
+  Enabled: false
+
 StringLiterals:
   EnforcedStyle: double_quotes
 

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in elmas.gemspec
 gemspec

data/Guardfile

@@ -1,11 +1,13 @@
-guard :rspec, cmd: 'rspec' do
+# frozen_string_literal: true
+
+guard :rspec, cmd: "rspec" do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { "spec" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch("spec/spec_helper.rb")  { "spec" }
 end
 
-guard :rubocop, all_on_start: false, cli: ['--format', 'clang', '--rails'] do
+guard :rubocop, all_on_start: false, cli: ["--format", "clang", "--rails"] do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})
-  watch('spec/spec_helper.rb')  
+  watch("spec/spec_helper.rb")
 end

data/README.md

@@ -18,6 +18,8 @@ Elmas means diamond, but in this case it's an API wrapper for [Exact Online](htt
 * [mipmip](https://github.com/mipmip)
 * [Bramjetten](https://github.com/Bramjetten)
 * [LaurensN](https://github.com/LaurensN)
+* [jdlombardozzi](https://github.com/jdlombardozzi)
+* [michielverkoijen](https://github.com/michielverkoijen)
 
 Thanks for helping! If you want to contribute read through this readme how to!
 
@@ -75,11 +77,8 @@ So combining all of this results in
 Elmas.configure do |config|
   config.client_id = ENV['CLIENT_ID']
   config.client_secret = ENV['CLIENT_SECRET']
-end
-Elmas.configure do |config|
+  config.redirect_uri = ENV['REDIRECT_URI']
   config.access_token = Elmas.authorize(ENV['EXACT_USER_NAME'], ENV['EXACT_PASSWORD']).access_token
-end
-Elmas.configure do |config|
   config.division = Elmas.authorize_division
 end
 ```
@@ -98,6 +97,18 @@ unless Elmas.authorized?
 end
 ```
 
+### Logger
+
+The default logger is STDOUT. A custom logger can be be configured.
+```ruby
+  dir = File.dirname("./tmp/errors.log")
+  FileUtils.mkdir_p(dir) unless File.directory?(dir)
+
+  Elmas.configure do |config|
+    config.logger = ::Logger.new("./tmp/errors.log", "daily")
+  end
+```
+
 ## Accessing the API
 
 We can retrieve data from the API using the following syntax.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
 task :rubocop do
@@ -8,4 +10,4 @@ task :rspec do
   sh "rspec"
 end
 
-task default: [:rubocop, :rspec]
+task default: %i[rubocop rspec]

data/elmas.gemspec

@@ -1,37 +1,39 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'elmas/version'
+require "elmas/version"
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name          = "elmas"
   spec.authors       = ["Marthyn"]
   spec.email         = ["MarthynOlthof@hoppinger.nl"]
 
-  spec.summary       = %q{API wrapper for Exact Online}
+  spec.summary       = "API wrapper for Exact Online"
   spec.homepage      = "https://github.com/exactonline/exactonline-api-ruby-client"
-  spec.licenses      = %w(MIT)
+  spec.licenses      = %w[MIT]
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
-  spec.require_paths = %w(lib)
+  spec.require_paths = %w[lib]
   spec.version       = Elmas::Version.to_s
 
+  spec.add_dependency "activeresource"
+  spec.add_dependency "activesupport"
   spec.add_dependency "faraday", [">= 0.12.1"]
   spec.add_dependency "mechanize", ">= 2.7.5"
-  spec.add_dependency "activesupport"
-  spec.add_dependency "activeresource"
 
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-rubocop"
+  spec.add_development_dependency "listen"
+  spec.add_development_dependency "mutant-rspec"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "ruby_dep"
+  spec.add_development_dependency "rubycritic"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-rcov"
   spec.add_development_dependency "webmock"
-  spec.add_development_dependency "rubycritic"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "guard-rubocop"
-  spec.add_development_dependency "listen"
-  spec.add_development_dependency "ruby_dep"
-  spec.add_development_dependency "mutant-rspec"
-  spec.add_development_dependency "dotenv"
 end

data/lib/elmas.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require "elmas/version"
 require "elmas/api"
 require "elmas/config"
 require "elmas/response"
 require "elmas/client"
-require "elmas/log"
 require "elmas/resource"
 require "elmas/result_set"
 require "elmas/sanitizer"
@@ -44,10 +45,10 @@ require "elmas/resources/vat_code"
 require "elmas/resources/general_journal_entry"
 require "elmas/resources/general_journal_entry_line"
 require "elmas/resources/payment_condition"
+require "elmas/resources/division"
 
 module Elmas
   extend Config
-  extend Log
 
   def self.client(options = {})
     Elmas::Client.new(options)
@@ -63,4 +64,12 @@ module Elmas
   def self.respond_to?(method, include_all = false)
     client.respond_to?(method, include_all) || super
   end
+
+  def self.info(msg)
+    logger.info(msg)
+  end
+
+  def self.error(msg)
+    logger.error(msg)
+  end
 end

data/lib/elmas/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path("../request", __FILE__)
 require File.expand_path("../config", __FILE__)
 require File.expand_path("../oauth", __FILE__)

data/lib/elmas/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "faraday"
 
 module Elmas

data/lib/elmas/config.rb

@@ -1,29 +1,33 @@
+# frozen_string_literal: true
+
 require "faraday"
 require "active_resource/threadsafe_attributes"
+require "logger"
 
 module Elmas
   module Config
     include ThreadsafeAttributes
     # An array of valid keys in the options hash
-    VALID_OPTIONS_KEYS = [
-      :access_token,
-      :adapter,
-      :client_id,
-      :client_secret,
-      :connection_options,
-      :redirect_uri,
-      :response_format,
-      :user_agent,
-      :endpoint,
-      :division,
-      :base_url,
-      :refresh_token
+    VALID_OPTIONS_KEYS = %i[
+      access_token
+      adapter
+      client_id
+      client_secret
+      connection_options
+      redirect_uri
+      response_format
+      user_agent
+      endpoint
+      division
+      base_url
+      refresh_token
+      logger
     ].freeze
 
     # By default, don't set a user access token
-    DEFAULT_ACCESS_TOKEN = "".freeze
+    DEFAULT_ACCESS_TOKEN = ""
 
-    DEFAULT_REFRESH_TOKEN = "".freeze
+    DEFAULT_REFRESH_TOKEN = ""
 
     # The adapter that will be used to connect if none is set
     #
@@ -31,27 +35,27 @@ module Elmas
     DEFAULT_ADAPTER = Faraday.default_adapter
 
     # By default, client id should be set in .env
-    DEFAULT_CLIENT_ID = "".freeze
+    DEFAULT_CLIENT_ID = ""
 
     # By default, client secret should be set in .env
-    DEFAULT_CLIENT_SECRET = "".freeze
+    DEFAULT_CLIENT_SECRET = ""
 
     # By default, don't set any connection options
     DEFAULT_CONNECTION_OPTIONS = {}.freeze
 
-    DEFAULT_BASE_URL = "https://start.exactonline.nl".freeze
+    DEFAULT_BASE_URL = "https://start.exactonline.nl"
 
     # The endpoint that will be used to connect if none is set
-    DEFAULT_ENDPOINT = "api/v1".freeze
+    DEFAULT_ENDPOINT = "api/v1"
 
     # the division code you want to connect with
-    DEFAULT_DIVISION = "".freeze
+    DEFAULT_DIVISION = ""
 
     # The response format appended to the path and sent in the 'Accept' header if none is set
     #
     DEFAULT_FORMAT = :json
 
-    DEFAULT_REDIRECT_URI = "https://www.getpostman.com/oauth2/callback".freeze
+    DEFAULT_REDIRECT_URI = "https://www.getpostman.com/oauth2/callback"
 
     # By default, don't set user agent
     DEFAULT_USER_AGENT = nil
@@ -59,6 +63,8 @@ module Elmas
     # An array of valid request/response formats
     VALID_FORMATS = [:json].freeze
 
+    DEFAULT_LOGGER = ::Logger.new(STDOUT)
+
     # @private
     threadsafe_attribute(*VALID_OPTIONS_KEYS)
 
@@ -93,6 +99,7 @@ module Elmas
       self.response_format    = DEFAULT_FORMAT
       self.user_agent         = DEFAULT_USER_AGENT
       self.refresh_token      = DEFAULT_REFRESH_TOKEN
+      self.logger             = DEFAULT_LOGGER
     end
   end
 end

data/lib/elmas/exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Elmas
   class BadRequestException < StandardError
     def initialize(response, parsed)

data/lib/elmas/oauth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "mechanize"
 require "uri"
 require "json"
@@ -7,6 +9,7 @@ require File.expand_path("../response", __FILE__)
 
 # from https://developers.exactonline.com/#Example retrieve access token.html
 module Elmas
+  # rubocop:disable Metrics/ModuleLength
   module OAuth
     def authorize(user_name, password, options = {})
       agent = Mechanize.new
@@ -18,6 +21,15 @@ module Elmas
       OauthResponse.new(get_access_token(code))
     end
 
+    def refresh_authorization
+      OauthResponse.new(get_refresh_token(refresh_token)).tap do |response|
+        Elmas.configure do |config|
+          config.access_token = response.access_token
+          config.refresh_token = response.refresh_token
+        end
+      end
+    end
+
     def authorized?
       # Do a test call, return false if 401 or any error code
       get("/Current/Me", no_division: true)
@@ -32,13 +44,10 @@ module Elmas
 
     def auto_authorize
       Elmas.configure do |config|
+        config.redirect_uri = ENV["REDIRECT_URI"]
         config.client_id = ENV["CLIENT_ID"]
         config.client_secret = ENV["CLIENT_SECRET"]
-      end
-      Elmas.configure do |config|
         config.access_token = Elmas.authorize(ENV["EXACT_USER_NAME"], ENV["EXACT_PASSWORD"]).access_token
-      end
-      Elmas.configure do |config|
         config.division = Elmas.authorize_division
       end
     end
@@ -67,6 +76,23 @@ module Elmas
       end
     end
 
+    # Return an access token from authorization via refresh token
+    def get_refresh_token(refresh_token)
+      conn = Faraday.new(url: config[:base_url]) do |faraday|
+        faraday.request :url_encoded
+        faraday.adapter Faraday.default_adapter
+      end
+
+      params = refresh_access_token_params(refresh_token)
+
+      conn.post do |req|
+        req.url "/api/oauth2/token"
+        req.body = params
+        req.headers["Accept"] = "application/json"
+        req.headers["Content-Type"] = "application/x-www-form-urlencoded"
+      end
+    end
+
     private
 
     def login(agent, user_name, password, options)
@@ -81,6 +107,7 @@ module Elmas
 
     def allow_access(agent)
       return if agent.page.uri.to_s.include?("getpostman")
+      return if agent.page.uri.to_s.include?(redirect_uri)
       form = agent.page.form_with(id: "PublicOAuth2Form")
       button = form.button_with(id: "AllowButton")
       agent.submit(form, button)
@@ -101,6 +128,15 @@ module Elmas
         redirect_uri: redirect_uri
       }
     end
+
+    def refresh_access_token_params(code)
+      {
+        client_id: client_id,
+        client_secret: client_secret,
+        grant_type: "refresh_token",
+        refresh_token: code
+      }
+    end
   end
 end
 

data/lib/elmas/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Elmas
   class Parser
     attr_accessor :parsed_json

data/lib/elmas/request.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Elmas
   # Defines HTTP request methods
   module Request

data/lib/elmas/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require File.expand_path("../utils", __FILE__)
 require File.expand_path("../exception", __FILE__)
 require File.expand_path("../uri", __FILE__)
@@ -24,8 +26,8 @@ module Elmas
     def find_all(options = {})
       @order_by = options[:order_by]
       @select = options[:select]
-      response = get(uri([:order, :select]))
-      response.results if response
+      response = get(uri(%i[order select]))
+      response&.results
     end
 
     # Pass filters in an array, for example 'filters: [:id, :name]'
@@ -33,14 +35,14 @@ module Elmas
       @filters = options[:filters]
       @order_by = options[:order_by]
       @select = options[:select]
-      response = get(uri([:order, :select, :filters]))
-      response.results if response
+      response = get(uri(%i[order select filters]))
+      response&.results
     end
 
     def find
       return nil unless id?
       response = get(uri([:id]))
-      response.results.first if response
+      response&.results&.first
     end
 
     # Normally use the url method (which applies the filters) but sometimes you only want to use the base path or other paths