esignatur 1.2.6 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7dd1f4618e2aa836b73c01caa30e006dc70225fcac39c50ce1800f8f9774a7f
-  data.tar.gz: dc03a0757930cea8d2b911363f6087820e60384655812a29de2a35665afc4694
+  metadata.gz: 6a6949dca95e7db555ce0ef6a51305250ae96b6915d4d22816c6cd4f39fb04f2
+  data.tar.gz: 40e103f6364ef082093550b9022c07931a4ab779198e971d40f2e8a1d5a9bda9
 SHA512:
-  metadata.gz: 2f19152b0734e12e5fc6b96e235402062129555212d8438d51ed5e90d2d8d1d5337336a5ea96dd2321712e565a412983afb1e26f270fd72171bbf4d5a81b4f08
-  data.tar.gz: fb8130fa4f5b997f2f4d55c85902fa4d705e747f1f51334972ddca8e5ad825e6f79152701e3ebc1d043a2a50e674fc9a50e5eadabe3be647b67506b5bb131998
+  metadata.gz: fd2676c1c5fe06d34609d14e6c5d6cca6ae66c9e822859d1e7378aa8b8f89db7e5248c870e5524957a6f8b5098886ee7e751d2a10a334f3546bb2a0e7cd4efa9
+  data.tar.gz: b10cdbacbdc0cb0f9acd78edf07e5b8dec4b2b786039a9ad2679e81d1bc362d3a87153199ae8225efc4ec065fbbf3d44f0b6b9ef3b758934bb47b1abcc4b4656

data/.github/workflows/ruby.yml

@@ -0,0 +1,19 @@
+name: Ruby
+on: [push, pull_request]
+jobs:
+  specs:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.0', '3.2', '3.3']
+
+    runs-on: ubuntu-latest
+    env:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rake

data/{.hound → .hound.yml}

@@ -1,3 +1,4 @@
 rubocop:
   config_file: .rubocop.yml
+  version: 1.5.2
 fail_on_violations: true

data/.rubocop.yml

@@ -3,7 +3,7 @@ require: rubocop-rspec
 RSpec/NestedGroups:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Enabled: true
   Max: 120
 
@@ -18,7 +18,7 @@ Lint/AmbiguousBlockAssociation:
   Exclude:
     - spec/**/*.rb
 
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   AllowedNames:
     - 'to'
     - 'at'
@@ -28,7 +28,7 @@ Naming/UncommunicativeMethodParamName:
     - 'as'
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.0
   Exclude:
     - bin/*
     - esignatur.gemspec

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+3.2.1

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+* Added/Changed/Deprecated/Removed/Fixed/Security: YOUR CHANGE HERE
+
+## [2.0.0](2024-01-30)
+
+* Added: CHANGELOG.md
+* Changed: creator_id won't be passed in request body, but it will always included in the headers

data/Gemfile.lock

@@ -1,109 +1,132 @@
 PATH
   remote: .
   specs:
-    esignatur (1.2.6)
-      activesupport (>= 3.0)
+    esignatur (2.1.0)
+      activesupport (>= 4.0)
       faraday (>= 0.10)
+      json (>= 2.6.2)
+      rexml (>= 3.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (7.1.3)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
-    byebug (10.0.2)
-    codecov (0.1.10)
-      json
-      simplecov
-      url
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    faraday (0.15.4)
-      multipart-post (>= 1.2, < 3)
-    hashdiff (0.3.7)
-    i18n (1.6.0)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    byebug (11.1.3)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crack (0.4.6)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    drb (2.2.0)
+      ruby2_keywords
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    hashdiff (1.1.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.1)
-    json (2.1.0)
-    method_source (0.9.0)
-    minitest (5.11.3)
-    multipart-post (2.1.1)
-    parallel (1.12.1)
-    parser (2.5.1.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.6.0)
-      byebug (~> 10.0)
-      pry (~> 0.10)
-    public_suffix (3.0.3)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
+    json (2.7.1)
+    method_source (1.0.0)
+    minitest (5.21.2)
+    mutex_m (0.2.0)
+    net-http (0.4.1)
+      uri
+    parallel (1.24.0)
+    parser (3.3.1.0)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    public_suffix (5.0.4)
+    racc (1.8.0)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.2)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    rubocop (0.57.2)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.5.2)
       parallel (~> 1.10)
-      parser (>= 2.5)
-      powerpack (~> 0.1)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    rubocop-rspec (1.27.0)
-      rubocop (>= 0.56.0)
-    ruby-progressbar (1.9.0)
-    safe_yaml (1.0.4)
-    simplecov (0.16.1)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-rspec (2.4.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.4.0)
-    url (0.3.2)
-    webmock (3.4.2)
-      addressable (>= 2.3.6)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    strscan (3.1.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (1.8.0)
+    uri (0.13.0)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (>= 1.16)
-  codecov (>= 0.1.10)
+  codecov (>= 0.2.0)
   esignatur!
   pry-byebug
   rake (>= 10.0)
   rspec (>= 3.0)
-  rubocop (>= 0.57)
+  rubocop (= 1.5.2)
   rubocop-rspec (>= 1.27)
   simplecov (>= 0.16.1)
   webmock (>= 3.4)
 
 BUNDLED WITH
-   1.17.2
+   2.5.5

data/README.md

@@ -26,7 +26,7 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-esignatur = Esignatur::Client.new(api_key: your_api_key)
+esignatur = Esignatur::Client.new(api_key: your_api_key, creator_id: your_creator_id)
 
 esignatur.orders.where(modified_since: Date.new(2000, 1, 1))
 
@@ -35,7 +35,7 @@ order = esignatur.orders.find(esignatur_order_id)
 order = esignatur.orders.build
 order.create(some_order_params) # creates order on esignatur side
 order.status # returns Status object
-order.cancel(creator_id: '123') # => true/false
+order.cancel
 
 pade_list = order.pades_list
 pade_list.first.document_data # decoded body of the document

data/esignatur.gemspec

@@ -2,6 +2,7 @@
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "esignatur/version"
+require "yaml"
 
 Gem::Specification.new do |spec|
   spec.name          = "esignatur"
@@ -32,15 +33,17 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "faraday", ">= 0.10"
-  spec.add_dependency "activesupport", ">= 3.0"
+  spec.add_dependency "activesupport", ">= 4.0"
+  spec.add_dependency "rexml", ">= 3.2"
+  spec.add_dependency "json", ">= 2.6.2"
 
   spec.add_development_dependency "bundler", ">= 1.16"
   spec.add_development_dependency "rake", ">= 10.0"
   spec.add_development_dependency "rspec", ">= 3.0"
-  spec.add_development_dependency "rubocop", '>= 0.57'
+  spec.add_development_dependency "rubocop", YAML.load_file('.hound.yml')['rubocop']['version']
   spec.add_development_dependency "rubocop-rspec", '>= 1.27'
   spec.add_development_dependency "webmock", '>= 3.4'
-  spec.add_development_dependency "codecov", '>= 0.1.10'
+  spec.add_development_dependency "codecov", '>= 0.2.0'
   spec.add_development_dependency "simplecov", '>= 0.16.1'
   spec.add_development_dependency "pry-byebug"
 end

data/lib/esignatur/api.rb

@@ -10,38 +10,51 @@ module Esignatur
 
     DEFAULT_BASE_URL = 'https://api.esignatur.dk'
 
-    def initialize(api_key:, base_url: DEFAULT_BASE_URL)
+    attr_reader :creator_id
+
+    def initialize(api_key:, creator_id:, base_url: DEFAULT_BASE_URL, timeout: nil)
       @api_key = api_key.to_s
       @base_url = base_url
+      @creator_id = creator_id
+      @default_timeout = timeout
     end
 
-    def post(relative_url, data:, headers: {})
-      make_request(:post, relative_url, data: data, extra_headers: headers)
+    def post(relative_url, data:, headers: {}, timeout: nil)
+      make_request(:post, relative_url, data: data, extra_headers: headers, timeout: timeout)
     end
 
-    def get(relative_url, headers: {})
-      make_request(:get, relative_url, extra_headers: headers)
+    def get(relative_url, headers: {}, timeout: nil)
+      make_request(:get, relative_url, extra_headers: headers, timeout: timeout)
     end
 
     private
 
-    attr_reader :base_url, :api_key
+    attr_reader :base_url, :api_key, :default_timeout
 
-    def make_request(http_method, relative_url, extra_headers: {}, data: nil)
+    def make_request(http_method, relative_url, extra_headers: {}, data: nil, timeout: nil)
       url = URI.join(base_url, relative_url).to_s
-
       headers = default_headers.merge(extra_headers)
-      raw_response = Faraday.public_send(http_method, url, data&.to_json, headers)
+
+      raw_response = connection(timeout: timeout).public_send(http_method, url, data&.to_json, headers)
       request = RequestInfo.new(http_method, url, headers)
       Esignatur::Api::Response.new(raw_response, request: request)
     end
 
+    def connection(timeout: nil)
+      request_timeout = timeout || default_timeout
+
+      Faraday.new do |conn|
+        conn.options.timeout = request_timeout if request_timeout
+      end
+    end
+
     def default_headers
       {
         'X-eSignatur-Id' => api_key,
         'Accept' => 'application/json',
-        'Content-Type' => 'application/json'
-      }
+        'Content-Type' => 'application/json',
+        'X-eSignatur-CreatorId' => creator_id&.to_s
+      }.compact
     end
   end
 end

data/lib/esignatur/client.rb

@@ -4,8 +4,8 @@ module Esignatur
   class Client
     DEFAULT_BASE_URL = 'https://api.esignatur.dk'
 
-    def initialize(api_key:, base_url: DEFAULT_BASE_URL)
-      @api = Esignatur::Api.new(api_key: api_key, base_url: base_url)
+    def initialize(**options)
+      @api = Esignatur::Api.new(**options)
     end
 
     def orders

data/lib/esignatur/order.rb

@@ -19,12 +19,14 @@ module Esignatur
       @api = api
     end
 
-    def create(attributes)
-      response = api_post('Order/Create', attributes)
+    def create(attributes = {}, **keyword_attributes)
+      response = api_post('Order/Create', attributes.merge(keyword_attributes))
+
       if errors.empty?
         body = response.json_body
         @attributes = attributes.merge(id: body.fetch('OrderId')).merge(body)
       end
+
       self
     end
 
@@ -36,14 +38,11 @@ module Esignatur
       @status ||= Esignatur::Status.new(order: self, api: api).tap(&:fetch)
     end
 
-    def cancel(attributes)
-      camelized_attributes = attributes.transform_keys(&:to_s).transform_keys(&:camelize)
-      creator_id = camelized_attributes.delete('CreatorId')
-
+    def cancel(attributes = {}, **keyword_attributes)
+      camelized_attributes = attributes.merge(keyword_attributes).transform_keys(&:to_s).transform_keys(&:camelize)
       data = { 'OrderId' => id }.merge(camelized_attributes.compact)
-      headers = { 'X-eSignatur-CreatorId': creator_id }
 
-      api_post('Cancel/CancelOrder', data, headers: headers).success?
+      api_post('Cancel/CancelOrder', data).success?
     end
 
     def pades_list

data/lib/esignatur/orders.rb

@@ -14,8 +14,8 @@ module Esignatur
       @api = api
     end
 
-    def create(attributes)
-      build.create(attributes)
+    def create(attributes = {}, **keyword_attributes)
+      build.create(attributes, **keyword_attributes)
     end
 
     def build
@@ -28,7 +28,7 @@ module Esignatur
 
     def all
       @all ||= begin
-        response = api_get("OrderInfo/OrdersForAdministrator/#{creator_id}", headers: headers_for_all_query)
+        response = api_get("OrderInfo/OrdersForAdministrator/#{api.creator_id}", headers: headers_for_all_query)
         response.json_body.fetch('SignOrders').map do |raw_order|
           order_attributes = raw_order.merge(id: raw_order.fetch('SignOrderId'))
           Esignatur::Order.new(attributes: order_attributes, api: api)
@@ -52,15 +52,5 @@ module Esignatur
       modified_since = scope[:modified_since]&.iso8601
       modified_since ? { 'If-Modified-Since' => modified_since } : {}
     end
-
-    def creator_id
-      scope.fetch(:creator_id) do
-        raise(
-          Esignatur::MissingAttributeError,
-          'You need to specify creator_id in order to fech orders. ' \
-          'You can do this with `esignatur.orders.where(creator_id: 123)`'
-        )
-      end
-    end
   end
 end

data/lib/esignatur/pades.rb

@@ -37,7 +37,12 @@ module Esignatur
     end
 
     def fetch
-      response = api_post('Pades/Download', 'Id' => order.id, 'AgreementId' => attributes['AgreementId'])
+      response = api_post(
+        'Pades/Download',
+        {
+          'Id' => order.id, 'AgreementId' => attributes['AgreementId']
+        }
+      )
       @attributes = response.json_body if errors.empty?
       self
     end

data/lib/esignatur/source_document.rb

@@ -22,8 +22,11 @@ module Esignatur
     end
 
     def fetch
-      response = api_post('SourceDocument/Download',
-                          'Id' => order.id, 'DocumentIndex' => 0)
+      response = api_post(
+        'SourceDocument/Download',
+        { 'Id' => order.id, 'DocumentIndex' => 0 }
+      )
+
       @attributes = response.json_body if errors.empty?
       self
     end

data/lib/esignatur/user.rb

@@ -10,14 +10,18 @@ module Esignatur
 
     DEFAULT_BASE_URL = 'https://api.esignatur.dk'
 
-    def initialize(api_key:, base_url: DEFAULT_BASE_URL)
-      @api = Esignatur::Api.new(api_key: api_key, base_url: base_url)
+    def initialize(api_key:, base_url: DEFAULT_BASE_URL, creator_id:)
+      @api = Esignatur::Api.new(
+        api_key: api_key,
+        base_url: base_url,
+        creator_id: creator_id
+      )
+
       @attributes = {}
     end
 
-    def find_by(user_id:, creator_id:)
-      headers = { 'X-eSignatur-CreatorId': creator_id }
-      response = api_get("user/get/#{user_id}", headers: headers)
+    def find_by(user_id:)
+      response = api_get("user/get/#{user_id}")
       @attributes = response.json_body if errors.empty?
       self
     end

data/lib/esignatur/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Esignatur
-  VERSION = '1.2.6'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esignatur
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 2.1.0
 platform: ruby
 authors:
 - Povilas Jurcys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-19 00:00:00.000000000 Z
+date: 2024-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -30,14 +30,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +112,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.57'
+        version: 1.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.57'
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +156,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.10
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -171,12 +199,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".hound"
+- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -219,8 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: ruby API client for esignatur.dk

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.5.1
-before_install: gem install bundler -v 1.16.2