universign 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37fcda1aff466ea92b52af39d74396b7fbed250a
-  data.tar.gz: 5043df18c256466473d81a35a9578deccbeffcc5
+  metadata.gz: 4a162d62ec1ebc95ac4c719c2bebe7b47f64f7df
+  data.tar.gz: bc40b9c1401827933fd9d4223f7d199447929cb1
 SHA512:
-  metadata.gz: 79116490f911fabbf5ece6549efdf1c203b3af42f943d39a4e4083700be8ef906ca8485f6f0d01994a10d5c9932461ad56f7c274b9a0620f17178b079d9714b6
-  data.tar.gz: b51c6c92cdba641ed41c703792b8a731069429268710e9493ec4b860d55b5829fd180ca9482af13a24c1fc0b255caaf524e1b92d3abede29d9b3aa1d2cbd2df2
+  metadata.gz: 55c5e8b2e43b16ba960f67d7400b53791123da170f4a81a3611bfdc06557b8ec539a18108251faec05b3ae8a71314f7e5b0e60834a652384f04117e23a23071d
+  data.tar.gz: 4b215f199a03f964cfb78118cfc14032de3f723c91f376c83f742253deb41d4d02489c5cb5b4ae562b4c031df206297d949ff1e8382f9167efa6eb068066a50a

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Documentation: 
+  Enabled: false
+Style/FirstParameterIndentation:
+  IndentationWidth: 4

data/Rakefile

@@ -1,6 +1,15 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['Rakefile', 'lib/**/*.rb']
+  # only show the files with failures
+  # task.formatters = ['files']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: [:rubocop, :spec]

data/lib/universign.rb

@@ -1,10 +1,10 @@
 # encoding: utf-8
 require 'universign/version'
+require 'universign/hash'
 require 'base64'
 require 'xmlrpc/client'
 
 module Universign
-
   class << self
     attr_accessor :configuration
   end
@@ -14,6 +14,7 @@ module Universign
     yield(configuration) if block_given?
   end
 
+  # Configuration class
   class Configuration
     attr_accessor :language, :production, :user, :password, :debug,
                   :profile
@@ -27,79 +28,82 @@ module Universign
   end
 
   module Sign
-
     class << self
+      SignerDefaultOptions = { firstname: nil,
+                               lastname: nil,
+                               organization: nil,
+                               profile: 'default',
+                               emailAddress: nil,
+                               phoneNum: nil,
+                               role: 'signer',
+                               signatureField: nil,
+                               successURL: nil,
+                               cancelURL: nil,
+                               failURL: nil,
+                               certificateType: 'simple',
+                               idDocuments: nil
+      }.freeze
+      SANDBOX_URL = 'sign.test.cryptolog.com'.freeze
+      PROD_URL = 'sign.cryptolog.com'.freeze
 
       def client
-        raise 'You need to set config options' if Universign.configuration.nil?
-        host = Universign.configuration.production ? 'sign.cryptolog.com' : 'sign.test.cryptolog.com'
+        fail 'You need to set config options' if Universign.configuration.nil?
+        host = Universign.configuration.production ? PROD_URL : SANDBOX_URL
         path = '/sign/rpc'
         client = Universign::Sign::Client.new(
-            host, path, nil, nil, nil, Universign.configuration.user, Universign.configuration.password, true
+            host, path, nil, nil, nil,
+            Universign.configuration.user,
+            Universign.configuration.password, true
         )
         client.set_debug if Universign.configuration.debug
         client
       end
 
-    end
+      def transaction_signer(options = {})
+        options = options.reverse_merge(SignerDefaultOptions)
+        validate_transaction_signer_argument options
+        options.reject! { |_, v| v.nil? }
+      end
 
-    Document = Struct.new(:content, :name)
-    Signer = Struct.new(
-        :phoneNum,
-        :emailAddress,
-        :firstname,
-        :lastname,
-        :successURL,
-        :failURL,
-        :cancelURL
-    )
+      def transaction_document(content, name)
+        { content: XMLRPC::Base64.new(content), name: name }
+      end
 
-    def self.transactionSigner(phoneNum, emailAddress, firstname, lastname, successURL, failURL, cancelURL)
-      Signer.new(phoneNum, emailAddress, firstname, lastname, successURL, failURL, cancelURL)
-    end
+      private
 
-    def self.transactionDocument(content, name)
-      Document.new(XMLRPC::Base64.new(content), name)
+      def validate_transaction_signer_argument(options)
+        fail(ArgumentError, 'You have to provide a firstname') if
+            options[:firstname].empty?
+        fail(ArgumentError, 'You have to provide a lastname') if
+            options[:lastname].empty?
+        fail(ArgumentError, 'You have to provide an email') if
+            options[:emailAddress].empty?
+      end
     end
 
     class Client < XMLRPC::Client
-
-      RequestTransaction = Struct.new(
-          :documents,
-          :signers,
-          :handwrittenSignatureMode,
-          :profile,
-          :certificateType,
-          :language
-      )
-
       # Request signature (Client side)
-      def requestTransaction(transactionSigners, transactionDocuments)
-        transactionSigners = [transactionSigners] unless transactionSigners.is_a? Array
-        transactionDocuments = [transactionDocuments] unless transactionDocuments.is_a? Array
-        request = RequestTransaction.new(
-            transactionDocuments,
-            transactionSigners,
-            0,
-            Universign.configuration.profile,
-            'simple',
-            Universign.configuration.language
-        )
+      def request_transaction(signers, docs)
+        signers = [signers] unless signers.is_a? Array
+        docs = [docs] unless docs.is_a? Array
+        request = { documents: docs, signers: signers,
+                    handwrittenSignatureMode: 0,
+                    profile: Universign.configuration.profile,
+                    language: Universign.configuration.language }
         call('requester.requestTransaction', request)
       end
 
-      def getTransactionInfo(transactionId)
-        call('requester.getTransactionInfo', transactionId)
+      def get_transaction_info(transaction_id)
+        call('requester.getTransactionInfo', transaction_id)
       end
 
-      def getDocuments(transactionId)
-        call('requester.getDocuments', transactionId)
+      def get_documents(transaction_id)
+        call('requester.getDocuments', transaction_id)
       end
 
       def set_debug
-        @http.set_debug_output($stderr);
+        @http.set_debug_output($stderr)
       end
-
     end
   end
 end

data/lib/universign/hash.rb

@@ -0,0 +1,7 @@
+class Hash
+  unless Hash.respond_to? :reverse_merge
+    def reverse_merge(other_hash)
+      other_hash.merge(self)
+    end
+  end
+end

data/lib/universign/version.rb

@@ -1,3 +1,3 @@
 module Universign
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'.freeze
 end

data/universign.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.36.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: universign
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Matthieu Foillard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-27 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.36.0
 description: 'A ruby client for the Universign XML-RPC api. Note : VERY EXPERIMENTAL
   AND INCOMPLETE'
 email:
@@ -63,12 +77,14 @@ files:
 - ".gitignore"
 - ".rbenv-gemsets"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/universign.rb
+- lib/universign/hash.rb
 - lib/universign/version.rb
 - universign.gemspec
 homepage: https://www.github.com/mgtf/universign