mifiel 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 202e1a5ee696fcd1a42eba6aeedd9faf8906dce0
-  data.tar.gz: 8e339531052e3a140214567254c4d354554b174f
+  metadata.gz: 824c42905ab5539e1400765da354b7856b0867c5
+  data.tar.gz: b14bf9cd247bcb5908a236809f7a8d2b62d9585b
 SHA512:
-  metadata.gz: a3139f2aa18d3856386e9204f95cd1662c3a0a2b8acc9425a6dd482dd8fc30a91bf2aba1730152644b81a97488b57faf5fb2eebb6a692c7fac7920dc5d6c3987
-  data.tar.gz: df4d1ac6f776051e549913e2e1f2d7d166e53aee7d87d2ff8913d6ee26e55fbffa71f8df9a69718b55522bd6e4cb5867b5c987327dd3e16497981c43a7e1e873
+  metadata.gz: c4967e263f0c34aa45c82e9771a2e3c53c9d894ff86b6cdc504a2c439c45de8e649b61966a8f905503c15af164de2128b7945ccb9d35d148b1da66d20058d0ef
+  data.tar.gz: 98a35a5cb8eca9ec7855fb52c4e110b7a3bfb5b8068a8feb8a51cd6e10c9e966c318e53e54572784daa38bbf26ec85b2b8e52f70c71a04e77ca0fb011b98fef4

data/.gitignore

@@ -13,3 +13,6 @@
 *.a
 mkmf.log
 rubocop.html
+.ruby-gemset
+.ruby-version
+*.sublime-workspace

data/Gemfile

@@ -2,3 +2,13 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mifiel.gemspec
 gemspec
+
+group :development, :test do
+  gem 'coveralls', require: false
+  gem 'guard', '2.13.0'
+  gem 'guard-rspec'
+  # compatible with ruby 2.2.1
+  gem 'listen', '3.1.1'
+  gem 'guard-rubocop'
+  gem 'terminal-notifier-guard'
+end

data/Guardfile

@@ -0,0 +1,37 @@
+notification :terminal_notifier
+
+rspec_options = {
+  all_after_pass: false,
+  cmd: 'rspec spec',
+  failed_mode: :focus
+}
+
+clearing :on
+
+guard :rspec, rspec_options do
+  require 'ostruct'
+
+  # Generic Ruby apps
+  rspec = OpenStruct.new
+  rspec.spec = ->(m) { "spec/#{m}_spec.rb" }
+  rspec.spec_dir = 'spec'
+  rspec.spec_helper = 'spec/spec_helper.rb'
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/mifiel/(.+)\.rb$}) do |m|
+    "spec/mifiel/#{m[1]}_spec.rb"
+  end
+  watch(%r{^lib/mifiel/(.+)\.rb$}) do |m|
+    "spec/mifiel/integration/#{m[1]}_spec.rb"
+  end
+  watch(rspec.spec_helper) { rspec.spec_dir }
+end
+
+rubocop_opts = {
+  all_on_start: false,
+  cli: '--format html -o rubocop.html'
+}
+guard :rubocop, rubocop_opts do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/README.md

@@ -58,9 +58,14 @@ Document methods:
 
 - Create:
 
+> Use only **hash** if you dont want us to have the file.<br>
+> Either **file** or **hash** must be provided.
+
 ```ruby
   document = Mifiel::Document.create(
     file: 'path/to/my-file.pdf',
+    # OR
+    hash: Digest::SHA256.hexdigest(File.read('path/to/my-file.pdf')), 
     signatories: [
       { name: 'Signer 1', email: 'signer1@email.com', tax_id: 'AAA010101AAA' },
       { name: 'Signer 2', email: 'signer2@email.com', tax_id: 'AAA010102AAA' }

data/Rakefile

@@ -1,5 +1,5 @@
 require 'bundler/gem_tasks'
 
 task :console do
-  exec 'irb -r mifiel -I ./lib'
+  exec 'pry -r mifiel -I ./lib'
 end

data/lib/mifiel/base.rb

@@ -5,12 +5,12 @@ module Mifiel
     after_request :rescue_errors
 
     def rescue_errors(_name, response)
-      if response.status == 400 # bad request
+      if (400..499).cover?(response.status)
         result = JSON.load(response.body)
         message = result['errors'] || [result['error']]
-        fail BadRequestError, message.to_a.join(', ')
+        raise BadRequestError, message.to_a.join(', ')
       elsif (500..599).cover?(response.status)
-        fail ServerError, "Could not process your request: status #{response.status}"
+        raise ServerError, "Could not process your request: status #{response.status}"
       end
     end
   end

data/lib/mifiel/document.rb

@@ -7,94 +7,40 @@ module Mifiel
     put :save, '/documents/:id'
     delete :delete, '/documents/:id'
 
-    def self.create(signatories:, file:nil, hash:nil, callback_url:nil)
-      fail ArgumentError, 'Either file or hash must be provided' if !file && !hash
-      fail ArgumentError, 'Only one of file or hash must be provided' if file && hash
-      sgries = {}
-      signatories.each_with_index { |s, i| sgries[i] = s }
-      rest_request = RestClient::Request.new(
-        url: "#{Mifiel.config.base_url}/documents",
-        method: :post,
-        payload: {
-          file: File.new(file),
-          original_hash: hash,
-          signatories: sgries,
-          callback_url: callback_url
-        },
-        ssl_version: 'SSLv23'
-      )
-      req = ApiAuth.sign!(rest_request, Mifiel.config.app_id, Mifiel.config.app_secret)
-      JSON.load(req.execute)
-    end
-
-    def sign(certificate_id:nil, certificate:nil)
-      fail ArgumentError, 'Either certificate_id or certificate must be provided' if !certificate_id && !certificate
-      fail ArgumentError, 'Only one of certificate_id or certificate must be provided' if certificate_id && certificate
-      fail NoSignatureError, 'You must first call build_signature or provide a signature' unless signature
-      params = { signature: signature }
-      params[:key] = certificate_id if certificate_id
-      if certificate
-        params[:certificate] = if certificate.encoding.to_s == 'UTF-8'
-                                 certificate.unpack('H*')[0]
-                               else
-                                 certificate
-                               end
-      end
-
-      Mifiel::Document._request("#{Mifiel.config.base_url}/documents/#{id}/sign", :post, params)
-    rescue ActiveRestClient::HTTPClientException => e
-      message = e.result.errors || [e.result.error]
-      raise MifielError, message.to_a.join(', ')
-    rescue ActiveRestClient::HTTPServerException
-      raise MifielError, 'Server could not process request'
+    def self.create(signatories:, file: nil, hash: nil, callback_url: nil)
+      raise ArgumentError, 'Either file or hash must be provided' if !file && !hash
+      raise ArgumentError, 'Only one of file or hash must be provided' if file && hash
+      payload = {
+        signatories: build_signatories(signatories),
+        callback_url: callback_url,
+        file: (File.new(file) if file),
+        original_hash: hash
+      }
+      process_request('/documents', :post, payload)
     end
 
-    def request_signature(email, cc:nil)
+    def request_signature(email, cc: nil)
       params = { email: email }
       params[:cc] = cc if cc.is_a?(Array)
       Mifiel::Document._request("#{Mifiel.config.base_url}/documents/#{id}/request_signature", :post, params)
-    rescue ActiveRestClient::HTTPClientException => e
-      message = e.result.errors || [e.result.error]
-      raise MifielError, message.to_a.join(', ')
-    rescue ActiveRestClient::HTTPServerException
-      raise MifielError, 'Server could not process request'
     end
 
-    def build_signature(private_key, private_key_pass)
-      self.signature ||= sign_hash(private_key, private_key_pass, original_hash)
+    def self.process_request(path, method, payload)
+      path[0] = '' if path[0] == '/'
+      rest_request = RestClient::Request.new(
+        url: "#{Mifiel.config.base_url}/#{path}",
+        method: method,
+        payload: payload,
+        ssl_version: 'SSLv23'
+      )
+      req = ApiAuth.sign!(rest_request, Mifiel.config.app_id, Mifiel.config.app_secret)
+      JSON.load(req.execute)
     end
 
-    private
-
-      # Sign the provided hash
-      # @param key [String] The contents of the .key file (File.read(...))
-      # @param pass [String] The password of the key
-      # @param hash [String] The hash or string to sign
-      #
-      # @return [String] Hex string of the signature
-      def sign_hash(key, pass, hash)
-        private_key = build_private_key(key, pass)
-        unless private_key.private?
-          fail NotPrivateKeyError, 'The private key is not valid'
-        end
-        signature = private_key.sign(OpenSSL::Digest::SHA256.new, hash)
-        signature.unpack('H*')[0]
-      end
-
-      def build_private_key(private_data, key_pass)
-        # create file so we can converted to pem
-        private_file = File.new("./tmp/tmp-#{rand(1000)}.key", 'w+')
-        private_file.write(private_data.force_encoding('UTF-8'))
-        private_file.close
-
-        key2pem_command = "openssl pkcs8 -in #{private_file.path} -inform DER -passin pass:#{key_pass}"
-        priv_pem_s, error, status = Open3.capture3(key2pem_command)
-
-        # delete file from file system
-        File.unlink private_file.path
-        fail PrivateKeyError, "#{error}, #{status}" unless error.empty?
-
-        OpenSSL::PKey::RSA.new priv_pem_s
-      end
+    def self.build_signatories(signatories)
+      sgries = {}
+      signatories.each_with_index { |s, i| sgries[i] = s }
+      sgries
+    end
   end
 end

data/lib/mifiel/version.rb

@@ -1,3 +1,3 @@
 module Mifiel
-  VERSION = '1.0.3'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/mifiel-ruby-api-client.sublime-project

@@ -0,0 +1,22 @@
+{
+
+  "folders":
+  [
+    {
+      "file_exclude_patterns":
+      [
+        "*.sublime-workspace"
+      ],
+      "folder_exclude_patterns":
+      [
+        "coverage",
+        ".bundle",
+        "tmp"
+      ],
+      "follow_symlinks": true,
+      "path": ".",
+      "tab_size": 2,
+      "translate_tabs_to_spaces": false,
+    }
+  ]
+}

data/mifiel.gemspec

@@ -32,4 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock',    '~> 1.22',  '>= 1.22.2'
   spec.add_development_dependency 'sinatra',    '~> 1.4',   '>= 1.4.7'
   spec.add_development_dependency 'rubocop',    '~> 0.36'
+  spec.add_development_dependency 'simplecov',  '~> 0.11'
 end

data/spec/mifiel/base_spec.rb

@@ -0,0 +1,31 @@
+describe Mifiel::Base do
+  describe 'rescue_errors' do
+    describe 'when bad request' do
+      it 'should raise error' do
+        base = Mifiel::Base.new
+        expect do
+          base.rescue_errors('blah', FakeResponse.new(400))
+        end.to raise_error(Mifiel::BadRequestError)
+      end
+    end
+
+    describe 'when server error' do
+      it 'should raise error' do
+        base = Mifiel::Base.new
+        expect do
+          base.rescue_errors('blah', FakeResponse.new(500))
+        end.to raise_error(Mifiel::ServerError)
+      end
+    end
+  end
+end
+
+class FakeResponse
+  attr_reader :status,
+              :body
+
+  def initialize(status)
+    @status = status
+    @body = '{"body": "some response"}'
+  end
+end

data/spec/mifiel/certificate_spec.rb

@@ -0,0 +1,12 @@
+describe Mifiel::Certificate do
+  describe '#create' do
+    let(:certificate) do
+      Mifiel::Certificate.create(
+        'spec/fixtures/FIEL_AAA010101AAA.cer'
+      )
+    end
+
+    it { expect(certificate).to be_a(Hash) }
+  end
+
+end

data/spec/mifiel/document_spec.rb

@@ -19,83 +19,40 @@ describe Mifiel::Document do
     end
   end
 
-  describe '#sign' do
-    let!(:signature) { 'signature' }
+  describe '#request_signature' do
     let!(:document) { Mifiel::Document.all.first }
-    let!(:certificate_id) { SecureRandom.uuid }
+    let!(:error_body) { { errors: ['some error'] }.to_json }
 
-    context 'without build_signature first called' do
-      it do
-        expect do
-          document.sign(certificate_id: certificate_id)
-        end.to raise_error(Mifiel::NoSignatureError)
-      end
-    end
-
-    context 'with build_signature called before' do
-      it do
-        document.build_signature(private_key, private_key_pass)
-        expect do
-          document.sign(certificate_id: certificate_id)
-        end.not_to raise_error
-      end
-    end
-
-    context 'with signature' do
-      it do
-        document.signature = signature
-        expect do
-          document.sign(certificate_id: certificate_id)
-        end.not_to raise_error
-      end
-    end
-
-    context 'with certificate' do
-      it do
-        document.build_signature(private_key, private_key_pass)
-        expect do
-          document.sign(certificate: certificate)
-        end.not_to raise_error
-      end
+    it '' do
+      expect do
+        document.request_signature('some@email.com')
+      end.not_to raise_error
     end
 
-    context 'with certificate in hex' do
-      it do
-        document.build_signature(private_key, private_key_pass)
-        expect do
-          document.sign(certificate: certificate.unpack('H*')[0])
-        end.not_to raise_error
+    context 'when bad request' do
+      before do
+        url = %r{mifiel.com\/api\/v1\/documents\/#{document.id}\/request_signature}
+        stub_request(:post, url).to_return(body: error_body, status: 404)
       end
-    end
-  end
 
-  describe '#build_signature' do
-    let!(:document) { Mifiel::Document.all.first }
-
-    context 'with a wrong private_key' do
-      it do
+      it '' do
         expect do
-          document.build_signature('asd', private_key_pass)
-        end.to raise_error(Mifiel::PrivateKeyError)
+          document.request_signature('some@email.com')
+        end.to raise_error(Mifiel::BadRequestError)
       end
     end
 
-    context 'with a private_key that is not a private_key' do
-      xit do
-        cer = OpenSSL::X509::Certificate.new(certificate)
-        expect do
-          document.build_signature(cer.public_key.to_der, private_key_pass)
-        end.to raise_error(Mifiel::NotPrivateKeyError)
+    context 'when server error' do
+      before do
+        url = %r{mifiel.com\/api\/v1\/documents\/#{document.id}\/request_signature}
+        stub_request(:post, url).to_return(body: error_body, status: 500)
       end
-    end
 
-    context 'with a wrong password' do
-      it do
+      it '' do
         expect do
-          document.build_signature('asd', private_key_pass)
-        end.to raise_error(Mifiel::PrivateKeyError)
+          document.request_signature('some@email.com')
+        end.to raise_error(Mifiel::ServerError)
       end
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -4,6 +4,13 @@ require 'pry-byebug'
 require 'mifiel'
 require 'webmock/rspec'
 
+require 'simplecov'
+require 'coveralls'
+SimpleCov.start do
+  add_filter '/spec/'
+end
+Coveralls.wear!
+
 Dir['./spec/support/**/*.rb'].each { |f| require f }
 
 RSpec.configure do |config|
@@ -12,6 +19,7 @@ RSpec.configure do |config|
     Mifiel.config do |conf|
       conf.app_id = 'APP_ID'
       conf.app_secret = 'APP_SECRET'
+      conf.base_url = 'http://www.mifiel.com/api/v1'
     end
   end
 

data/spec/support/fake_mifiel.rb

@@ -1,6 +1,21 @@
 require 'sinatra/base'
 
 class FakeMifiel < Sinatra::Base
+  get '/api/v1/keys' do
+    content_type :json
+    status 200
+    [
+      key,
+      key
+    ].to_json
+  end
+
+  post '/api/v1/keys' do
+    content_type :json
+    status 200
+    key(id: params[:id]).to_json
+  end
+
   get '/api/v1/documents' do
     content_type :json
     status 200
@@ -30,8 +45,28 @@ class FakeMifiel < Sinatra::Base
     ).to_json
   end
 
+  post '/api/v1/documents/:id/request_signature' do
+    content_type :json
+    status 200
+    { bla: 'Correo enviado' }.to_json
+  end
+
   private
 
+    def key(args={})
+      id = args[:id] || SecureRandom.uuid
+      {
+        id: id,
+        type_of: 'FIEL',
+        cer_hex: '308204cf30...1303030303030323',
+        owner: 'JORGE MORALES MENDEZ',
+        tax_id: 'MOMJ811012643',
+        expires_at: '2017-04-28T19:43:23.000Z',
+        expired: false
+      }
+    end
+
+    # rubocop:disable Metrics/MethodLength
     def document(args={})
       id = args[:id] || SecureRandom.uuid
       {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mifiel
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Genaro Madrid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -228,6 +228,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.36'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
 description: 
 email:
 - genmadrid@gmail.com
@@ -239,10 +253,9 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-gemset"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -254,10 +267,13 @@ files:
 - lib/mifiel/document.rb
 - lib/mifiel/errors.rb
 - lib/mifiel/version.rb
+- mifiel-ruby-api-client.sublime-project
 - mifiel.gemspec
 - spec/fixtures/FIEL_AAA010101AAA.cer
 - spec/fixtures/FIEL_AAA010101AAA.key
 - spec/fixtures/example.pdf
+- spec/mifiel/base_spec.rb
+- spec/mifiel/certificate_spec.rb
 - spec/mifiel/document_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_mifiel.rb
@@ -289,6 +305,8 @@ test_files:
 - spec/fixtures/FIEL_AAA010101AAA.cer
 - spec/fixtures/FIEL_AAA010101AAA.key
 - spec/fixtures/example.pdf
+- spec/mifiel/base_spec.rb
+- spec/mifiel/certificate_spec.rb
 - spec/mifiel/document_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_mifiel.rb

data/.ruby-gemset

@@ -1 +0,0 @@
-mifiel_api_client

data/.ruby-version

@@ -1 +0,0 @@
-2.1.2