esignatur 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c68634e762f47f536b57c23fb203b250aa8b5a7f14245f93c3de44e8ffc93f82
-  data.tar.gz: 18f4482bb8f1a05b6dbf036037028e0913e2cc4e55a75e5bc5ce64b4eaaf71c1
+SHA1:
+  metadata.gz: 5fe073d133639d410eb843518fad63d14a9bfe3f
+  data.tar.gz: 438fd000077e43b71082a46017d261d707179b40
 SHA512:
-  metadata.gz: 7456e5bd9dd0accf4fe20283c27646a26b520513875828999d1d33ad88c3f2e01a4ddc92fd442de025263278cc0692abc30b559f3891a155f5f251a01b981e70
-  data.tar.gz: 29f3d732f689c76ce42a2adb05c7c38c965e25e9d0fde5ddd19d0adfa312867922cdce062aca7101c26783f2eb7c702b355fc230587cf15e55812fffdb1996f2
+  metadata.gz: 80e43b37d1de91a249452513c7acc9b405b80b809dce37f076d0cb11e9a05e94e7c8ee317a7dcf17fd0100621c0595f29bf17a86d1e49741048e7e239c1d053f
+  data.tar.gz: a51c8865f60775672d5d27a4fb3fedab46a454074d8a0fc046a775b72f84f16127c252c7fcffa837e32b29304228033e20599c5450e7834df639cd34ad4af1bd

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in esignatur.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    esignatur (1.0.0)
+    esignatur (1.1.0)
       activesupport (>= 3.0)
       faraday (>= 0.10)
 

data/README.md

@@ -1,5 +1,10 @@
 # Esignatur
 
+
+[![Build Status](https://travis-ci.org/samesystem/esignatur.svg?branch=master)](https://travis-ci.org/samesystem/esignatur)
+[![codecov](https://codecov.io/gh/samesystem/esignatur/branch/master/graph/badge.svg)](https://codecov.io/gh/samesystem/esignatur)
+[![Documentation](https://readthedocs.org/projects/ansicolortags/badge/?version=latest)](https://samesystem.github.io/esignatur)
+
 https://api.esignatur.dk api ruby client
 
 ## Installation
@@ -22,15 +27,17 @@ Or install it yourself as:
 
 ```ruby
 esignatur = Esignatur::Client.new(api_key: your_api_key)
-esignatur.create_order()
+
 esignatur.orders.where(modified_since: Date.new(2000, 1, 1))
 
 order = esignatur.orders.find(1)
-order.status
-order.download_pades
-```
+order.create(some_order_params) # creates order on esignatur side
+order.status # returns Status object
+order.cancel # => true/false
 
-TODO: Write usage instructions here
+pades = order.pades
+pades.document_data # decoded body of the document
+```
 
 ## Development
 

data/lib/esignatur/api.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'esignatur/api/response'
+require 'esignatur/api/request_info'
 
 module Esignatur
   # all raw http requests are made using Api instance
@@ -31,11 +32,16 @@ module Esignatur
 
       headers = default_headers.merge(extra_headers)
       raw_response = Faraday.public_send(http_method, url, data&.to_json, headers)
-      Esignatur::Api::Response.new(raw_response)
+      request = RequestInfo.new(http_method, url, headers)
+      Esignatur::Api::Response.new(raw_response, request: request)
     end
 
     def default_headers
-      { 'X-eSignatur-Id' => api_key }
+      {
+        'X-eSignatur-Id' => api_key,
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
     end
   end
 end

data/lib/esignatur/api/request_info.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Esignatur
+  class Api
+    # api response wrapper
+    class RequestInfo
+      attr_reader :url, :headers, :http_method
+
+      def initialize(http_method, url, headers)
+        @url = url
+        @headers = headers
+        @http_method = http_method
+      end
+    end
+  end
+end

data/lib/esignatur/api/response.rb

@@ -1,21 +1,43 @@
 # frozen_string_literal: true
 
+require 'esignatur/error'
+
 module Esignatur
   class Api
     # api response wrapper
     class Response
-      attr_reader :original_response
+      attr_reader :request
 
-      def initialize(original_response)
+      def initialize(original_response, request:)
         @original_response = original_response
+        @request = request
       end
 
       def body
         original_response.body
       end
 
+      def status_code
+        original_response.status
+      end
+
+      def headers
+        original_response.headers
+      end
+
+      def success?
+        original_response.success?
+      end
+
+      def failed?
+        !success?
+      end
+
       def json_body
         JSON.parse(body)
+      rescue JSON::ParserError => error
+        error.extend(Esignatur::ParsingError)
+        raise error
       end
 
       def method_missing(method_name, *args)
@@ -28,6 +50,8 @@ module Esignatur
 
       private
 
+      attr_reader :original_response
+
       def original_respond_to?(method_name, *args)
         original_response.respond_to?(method_name, *args)
       end

data/lib/esignatur/api_resource.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Esignatur
+  # add methods that are shared for all api resources
+  module ApiResource
+    def errors
+      @errors || []
+    end
+
+    def last_response
+      @last_response
+    end
+
+    protected
+
+    def api_post(relative_url, data)
+      make_api_request(:post, relative_url, data: data)
+    end
+
+    def api_get(relative_url, **options)
+      make_api_request(:get, relative_url, **options)
+    end
+
+    private
+
+    def make_api_request(http_method, relative_url, **options)
+      @last_response = api.public_send(http_method, relative_url, **options).tap do |response|
+        @errors = []
+        @errors << response.headers['x-esignatur-error']
+        @errors << "Request failed with HTTP status: #{response.status_code}" if response.failed?
+        @errors = @errors.reject(&:nil?)
+      end
+    end
+  end
+end

data/lib/esignatur/client.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Esignatur
+  # main API class
   class Client
-    DEFAULT_BASE_URL = 'https://api.esignatur.dk'.freeze
+    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)

data/lib/esignatur/error.rb

@@ -1,3 +1,16 @@
+# frozen_string_literal: true
+
 module Esignatur
-  class Error < StandardError; end
+  # base error
+  module Error; end
+
+  # indicates that body is not parsable
+  module ParsingError
+    include Error
+  end
+
+  # indicates that some mandatory attribute is not given
+  class MissingAttributeError < StandardError
+    include Esignatur::Error
+  end
 end

data/lib/esignatur/order.rb

@@ -1,36 +1,46 @@
 # frozen_string_literal: true
 
+require 'esignatur/api_resource'
 require 'esignatur/pades'
+require 'esignatur/status'
 require 'active_support/core_ext/string/inflections'
 
 module Esignatur
   # esignatur order representation
   # More info: https://api.esignatur.dk/Documentation/Order
   class Order
-    attr_reader :id, :response_body
+    include ApiResource
 
-    def self.create(attributes, api:)
-      response = api.post('Order/Create', data: attributes)
-      body = response.json_body
-      new(body.fetch('OrderId'), response_body: response.body, api: api)
-    end
+    attr_reader :attributes
 
-    def initialize(id, response_body: nil, api:)
-      @id = id
-      @response_body = response_body
+    def initialize(attributes: {}, api:)
+      @attributes = attributes
       @api = api
     end
 
+    def create(attributes)
+      response = api_post('Order/Create', attributes)
+      if errors.empty?
+        body = response.json_body
+        @attributes = attributes.merge(id: body.fetch('OrderId')).merge(body)
+      end
+      self
+    end
+
+    def id
+      attributes[:id]
+    end
+
     def status
-      api.get("status/get/#{id}")
+      @status ||= Esignatur::Status.new(order: self, api: api).tap(&:fetch)
     end
 
     def cancel
-      api.get("Order/Cancel/#{id}").success?
+      api_get("Order/Cancel/#{id}").success?
     end
 
     def pades
-      Pades.new(order: self, api: api)
+      Esignatur::Pades.new(order: self, api: api)
     end
 
     private

data/lib/esignatur/orders.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require 'esignatur/api_resource'
+
 module Esignatur
   # esignatur order info collection representation.
   # more info: https://api.esignatur.dk/Documentation/OrderInfo
   class Orders
+    include ::Esignatur::ApiResource
     include Enumerable
 
     def initialize(scope: {}, api:)
@@ -12,7 +15,11 @@ module Esignatur
     end
 
     def create(attributes)
-      Order.create(attributes, api: api)
+      build.create(attributes)
+    end
+
+    def build
+      Esignatur::Order.new(api: api)
     end
 
     def where(new_scope)
@@ -21,9 +28,10 @@ module Esignatur
 
     def all
       @all ||= begin
-        response = api.get("OrderInfo/OrdersForAdministrator/#{creator_id}", headers: headers_for_all_query)
+        response = api_get("OrderInfo/OrdersForAdministrator/#{creator_id}", headers: headers_for_all_query)
         response.json_body.fetch('SignOrders').map do |raw_order|
-          Order.new(raw_order.fetch('SignOrderId'), response_body: raw_order, api: api)
+          order_attributes = raw_order.merge(id: raw_order.fetch('SignOrderId'))
+          Esignatur::Order.new(attributes: order_attributes, api: api)
         end
       end
     end
@@ -33,7 +41,7 @@ module Esignatur
     end
 
     def find(id)
-      Order.new(id, api: api)
+      Esignatur::Order.new(attributes: { id: id }, api: api)
     end
 
     private
@@ -48,7 +56,7 @@ module Esignatur
     def creator_id
       scope.fetch(:creator_id) do
         raise(
-          Esignatur::Error,
+          Esignatur::MissingAttributeError,
           'You need to specify creator_id in order to fech orders. ' \
           'You can do this with `esignatur.orders.where(creator_id: 123)`'
         )

data/lib/esignatur/pades.rb

@@ -1,27 +1,32 @@
 # frozen_string_literal: true
 
+require 'esignatur/api_resource'
+
 module Esignatur
   # esignature PAdES document representation.
   # More info: https://api.esignatur.dk/Documentation/Pades
   class Pades
-    attr_reader :order
+    include ApiResource
+
+    attr_reader :attributes, :order
 
     def initialize(order:, api:)
+      @attributes = {}
       @order = order
       @api = api
     end
 
     def document_data
-      Base64.decode64(response_body.fetch('DocumentData'))
-    end
-
-    def response_body
-      @response_body ||= \
-        api.post('Pades/Download', data: { 'Id' => order.id, 'DocumentIndex' => 0 }).json_body
+      fetch if attributes.empty?
+      Base64.decode64(attributes.fetch('DocumentData'))
     end
 
     private
 
     attr_reader :api
+
+    def fetch
+      @attributes = api_post('Pades/Download', 'Id' => order.id, 'DocumentIndex' => 0).json_body
+    end
   end
 end

data/lib/esignatur/status.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'esignatur/api_resource'
+
+module Esignatur
+  # esignatur status representation
+  # More info: https://api.esignatur.dk/Documentation/Status
+  class Status
+    include ApiResource
+
+    attr_reader :attributes, :order, :api
+
+    def initialize(order:, attributes: {}, api:)
+      @attributes = attributes
+      @order = order
+      @api = api
+    end
+
+    def fetch
+      @attributes = api_get("status/get/#{order.id}").json_body
+      self
+    end
+  end
+end

data/lib/esignatur/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esignatur
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Povilas Jurcys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2018-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -188,12 +188,15 @@ files:
 - esignatur.gemspec
 - lib/esignatur.rb
 - lib/esignatur/api.rb
+- lib/esignatur/api/request_info.rb
 - lib/esignatur/api/response.rb
+- lib/esignatur/api_resource.rb
 - lib/esignatur/client.rb
 - lib/esignatur/error.rb
 - lib/esignatur/order.rb
 - lib/esignatur/orders.rb
 - lib/esignatur/pades.rb
+- lib/esignatur/status.rb
 - lib/esignatur/version.rb
 homepage: https://github.com/samesystem/esignatur
 licenses:
@@ -215,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: ruby API client for esignatur.dk