mifiel 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4771294e3b399b292c103b30308f6803e8ec8c7
-  data.tar.gz: 4cc235a00d7d16efb58d900670f45a628c58b008
+  metadata.gz: 62a53025404e6eae0ad14166a1af2926695d4fae
+  data.tar.gz: f6ba1a0bd02be7b8211e6b404009942fb7f56e7d
 SHA512:
-  metadata.gz: 2f9460d1b14fb42270b49eb8a6edc945563dc0505a7ec8902f75e868253b1713632bbaec715cf74eb8eca422d3cb015527f15cec36716bbb62fef52eb9622137
-  data.tar.gz: ee57285f4b61a68110d254fb5baba7c8ebdeef5e0cbc149fbdaa7801b67d1f3f680de6a414f282f66299137bca3314706081897f25aa5ddc92f6370846f40e9f
+  metadata.gz: 1108db05b0ea2babce2d13fd32d9bc5ea4c6339cebbdee2db7b0a81b1bc42fe0f261390c0b6bfc39f17634741164fe2f2322444619003d54a43034421204d5a5
+  data.tar.gz: b614aba324ae18a85aa60551d7c428fdb0d234ca97351a445598469a703e5b3df26680a76cebf87785aaa1181ad07d4475f843fe5de4b82134dd9ff9a1b621c5

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+rubocop.html

data/.rubocop.yml

@@ -1,7 +1,7 @@
-Style/IndentationConsistency:
-  Enabled: false
+AllCops:
+  TargetRubyVersion: 2.1
 
-Style/SingleSpaceBeforeFirstArg:
+Style/IndentationConsistency:
   Enabled: false
 
 Style/AlignHash:
@@ -17,4 +17,8 @@ Style/EmptyLinesAroundBlockBody:
   Enabled: false
 
 Metrics/LineLength:
-  Max: 1000
+  Max: 190
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+- 2.1
+- 2.2
+- 2.3.0
+notifications:
+  email:
+    on_success: change
+    on_failure: always
+script:
+- bundle exec rubocop
+- bundle exec rspec spec

data/README.md

@@ -1,5 +1,9 @@
 # Mifiel
 
+[![Gem Version][gem-version-image]][gem-version-url]
+[![Build Status][travis-image]][travis-url]
+[![security][security-image]][security-url]
+
 Ruby SDK for [Mifiel](https://www.mifiel.com) API.
 Please read our [documentation](https://www.mifiel.com/api-docs/) for instructions on how to start using the API.
 
@@ -21,6 +25,19 @@ Or install it yourself as:
 
 ## Usage
 
+To start using the API you will need an APP_ID and a APP_SECRET which will be provided upon request (contact us at hola@mifiel.com).
+
+You will first need to create an account in [mifiel.com](https://www.mifiel.com) since the APP_ID and APP_SECRET will be linked to your account.
+
+Then you can configure the gem with:
+
+```ruby
+  Mifiel.config do |config|
+    config.app_id = '<APP_ID>'
+    config.app_secret = '<APP_SECRET>'
+  end
+```
+
 Document methods:
 
 - Find:
@@ -115,3 +132,11 @@ Certificate methods:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+
+[gem-version-image]: https://badge.fury.io/rb/mifiel.svg
+[gem-version-url]: https://badge.fury.io/rb/mifiel
+[security-url]: https://hakiri.io/github/Mifiel/ruby-api-client/master
+[security-image]: https://hakiri.io/github/Mifiel/ruby-api-client/master.svg
+[travis-image]: https://travis-ci.org/Mifiel/ruby-api-client.svg?branch=master
+[travis-url]: https://travis-ci.org/Mifiel/ruby-api-client

data/lib/mifiel.rb

@@ -7,7 +7,7 @@ module Mifiel
   autoload :Certificate, 'mifiel/certificate'
   autoload :Config, 'mifiel/config'
 
-  BASE_URL = 'https://www.mifiel.com/api/v1'
+  BASE_URL = 'https://www.mifiel.com/api/v1'.freeze
 
   def self.config
     if block_given?
@@ -16,5 +16,4 @@ module Mifiel
       Mifiel::Config
     end
   end
-
 end

data/lib/mifiel/base.rb

@@ -1,16 +1,17 @@
+require 'rest-client'
+
 module Mifiel
   class Base < ActiveRestClient::Base
     after_request :rescue_errors
 
-    def rescue_errors(name, response)
+    def rescue_errors(_name, response)
       if response.status == 400 # bad request
         result = JSON.load(response.body)
         message = result['errors'] || [result['error']]
-        raise BadRequestError, message.to_a.join(', ')
-      elsif (500..599).include?(response.status)
-        raise ServerError, "Server could not process your request: status #{response.status}"
+        fail BadRequestError, message.to_a.join(', ')
+      elsif (500..599).cover?(response.status)
+        fail ServerError, "Could not process your request: status #{response.status}"
       end
     end
-
   end
 end

data/lib/mifiel/certificate.rb

@@ -1,24 +1,21 @@
 module Mifiel
   class Certificate < Mifiel::Base
-
     get :all, '/keys'
     get :find, '/keys/:id'
     put :save, '/keys/:id'
     get :sat, '/keys/sat'
 
-    def self.create(file:)
+    def self.create(cer_file)
       rest_request = RestClient::Request.new(
         url: "#{Mifiel.config.base_url}/keys",
         method: :post,
         payload: {
-          cer_file: File.new(file)
+          cer_file: File.new(cer_file)
         },
         ssl_version: 'SSLv23'
       )
-      response = ApiAuth.sign!(rest_request, Mifiel.config.app_id, Mifiel.config.app_secret).execute
-      JSON.load(response)
+      req = ApiAuth.sign!(rest_request, Mifiel.config.app_id, Mifiel.config.app_secret)
+      JSON.load(req.execute)
     end
-
   end
-
 end

data/lib/mifiel/document.rb

@@ -1,9 +1,7 @@
-require 'rest-client'
 require 'open3'
 
 module Mifiel
   class Document < Mifiel::Base
-
     get :all, '/documents'
     get :find, '/documents/:id'
     put :save, '/documents/:id'
@@ -11,7 +9,7 @@ module Mifiel
 
     def self.create(file:, signatories:, hash:nil)
       sgries = {}
-      signatories.each_with_index {|s, i| sgries[i] = s}
+      signatories.each_with_index { |s, i| sgries[i] = s }
       rest_request = RestClient::Request.new(
         url: "#{Mifiel.config.base_url}/documents",
         method: :post,
@@ -22,8 +20,8 @@ module Mifiel
         },
         ssl_version: 'SSLv23'
       )
-      response = ApiAuth.sign!(rest_request, Mifiel.config.app_id, Mifiel.config.app_secret).execute
-      JSON.load(response)
+      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)
@@ -32,7 +30,13 @@ module Mifiel
       fail NoSignatureError, 'You must first call build_signature or provide a signature' unless signature
       params = { signature: signature }
       params[:key] = certificate_id if certificate_id
-      params[:certificate] = certificate.unpack('H*')[0] if certificate
+      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
@@ -42,6 +46,17 @@ module Mifiel
       raise MifielError, 'Server could not process request'
     end
 
+    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)
     end
@@ -57,7 +72,7 @@ module Mifiel
       def sign_hash(key, pass, hash)
         private_key = build_private_key(key, pass)
         unless private_key.private?
-          raise NotPrivateKeyError, "The private key is not valid"
+          fail NotPrivateKeyError, 'The private key is not valid'
         end
         signature = private_key.sign(OpenSSL::Digest::SHA256.new, hash)
         signature.unpack('H*')[0]
@@ -74,11 +89,9 @@ module Mifiel
 
         # delete file from file system
         File.unlink private_file.path
-        fail PrivateKeyError.new("#{error}, #{status}") unless error.empty?
+        fail PrivateKeyError, "#{error}, #{status}" unless error.empty?
 
         OpenSSL::PKey::RSA.new priv_pem_s
       end
-
   end
-
 end

data/lib/mifiel/version.rb

@@ -1,3 +1,3 @@
 module Mifiel
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'.freeze
 end

data/mifiel.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Mifiel::VERSION
   spec.authors       = ['Genaro Madrid']
   spec.email         = ['genmadrid@gmail.com']
-  spec.summary       = %q{Ruby SDK for mifiel.com.}
+  spec.summary       = 'Ruby SDK for mifiel.com.'
   spec.homepage      = 'https://github.com/Mifiel/ruby-api-client'
   spec.license       = 'MIT'
 
@@ -17,16 +17,18 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rest-client', '~> 1.7'
-  spec.add_runtime_dependency 'json', '~> 1.8'
-  spec.add_runtime_dependency 'api-auth', '~> 1.4'
+  spec.add_runtime_dependency 'rest-client',        '~> 1.7'
+  spec.add_runtime_dependency 'json',               '~> 1.8'
+  spec.add_runtime_dependency 'api-auth',           '~> 1.4'
   spec.add_runtime_dependency 'active_rest_client', '~> 1.2'
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.1', '>= 3.1.7'
-  spec.add_development_dependency 'pry', '~> 0.10', '>= 0.10.1'
-  spec.add_development_dependency 'pry-byebug', '~> 3.3', '>= 3.3.0'
-  spec.add_development_dependency 'bump', '~> 0.5', '>= 0.5.3'
-  spec.add_development_dependency 'webmock', '~> 1.22', '>= 1.22.2'
+  spec.add_development_dependency 'bundler',    '~> 1.6'
+  spec.add_development_dependency 'rake',       '~> 10.0'
+  spec.add_development_dependency 'rspec',      '~> 3.1',   '>= 3.1.7'
+  spec.add_development_dependency 'pry',        '~> 0.10',  '>= 0.10.1'
+  spec.add_development_dependency 'pry-byebug', '~> 3.3',   '>= 3.3.0'
+  spec.add_development_dependency 'bump',       '~> 0.5',   '>= 0.5.3'
+  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'
 end

data/spec/mifiel/document_spec.rb

@@ -7,12 +7,12 @@ describe Mifiel::Document do
     context 'with a document' do
       let(:document) do
         Mifiel::Document.create(
-            file: 'spec/fixtures/example.pdf',
-            signatories: [
-              { name: 'Signer 1', email: 'signer1@email.com', tax_id: 'AAA010101AAA' },
-              { name: 'Signer 2', email: 'signer2@email.com', tax_id: 'AAA010102AAA' }
-            ]
-          )
+          file: 'spec/fixtures/example.pdf',
+          signatories: [
+            { name: 'Signer 1', email: 'signer1@email.com', tax_id: 'AAA010101AAA' },
+            { name: 'Signer 2', email: 'signer2@email.com', tax_id: 'AAA010102AAA' }
+          ]
+        )
       end
 
       it { expect(document).to be_a(Hash) }
@@ -22,31 +22,49 @@ describe Mifiel::Document do
   describe '#sign' do
     let!(:signature) { 'signature' }
     let!(:document) { Mifiel::Document.all.first }
+    let!(:certificate_id) { SecureRandom.uuid }
 
     context 'without build_signature first called' do
       it do
-        expect{document.sign(certificate_id: 3)}.to raise_error(Mifiel::NoSignatureError)
+        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{document.sign(certificate_id: 3)}.not_to raise_error
+        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{document.sign(certificate_id: 3)}.not_to raise_error
+        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{document.sign(certificate: certificate)}.not_to raise_error
+        expect do
+          document.sign(certificate: certificate)
+        end.not_to raise_error
+      end
+    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
       end
     end
   end
@@ -56,20 +74,26 @@ describe Mifiel::Document do
 
     context 'with a wrong private_key' do
       it do
-        expect{document.build_signature('asd', private_key_pass)}.to raise_error(Mifiel::PrivateKeyError)
+        expect do
+          document.build_signature('asd', private_key_pass)
+        end.to raise_error(Mifiel::PrivateKeyError)
       end
     end
 
     context 'with a private_key that is not a private_key' do
       xit do
         cer = OpenSSL::X509::Certificate.new(certificate)
-        expect{document.build_signature(cer.public_key.to_der, private_key_pass)}.to raise_error(Mifiel::NotPrivateKeyError)
+        expect do
+          document.build_signature(cer.public_key.to_der, private_key_pass)
+        end.to raise_error(Mifiel::NotPrivateKeyError)
       end
     end
 
     context 'with a wrong password' do
       it do
-        expect{document.build_signature('asd', private_key_pass)}.to raise_error(Mifiel::PrivateKeyError)
+        expect do
+          document.build_signature('asd', private_key_pass)
+        end.to raise_error(Mifiel::PrivateKeyError)
       end
     end
   end

data/spec/spec_helper.rb

@@ -2,14 +2,20 @@ require 'pry'
 require 'byebug'
 require 'pry-byebug'
 require 'mifiel'
-# require 'webmock/rspec'
+require 'webmock/rspec'
 
 Dir['./spec/support/**/*.rb'].each { |f| require f }
 
-# WebMock.disable_net_connect!
+RSpec.configure do |config|
 
-Mifiel.config do |config|
-  config.app_id = '138b94faa5a43d35f60208449f0e0916de29575e'
-  config.app_secret = 'mJM3igFcJp8Iu/euEtr0ZTAGixmE+4K5R9o2TEOQEQfAiEuB7MpVwgMULoDxhJvbIUCDZ5l2nnxgL93I5JBXEw=='
-  config.base_url = 'http://localhost:3000/api/v1'
+  config.before(:suite) do
+    Mifiel.config do |conf|
+      conf.app_id = 'APP_ID'
+      conf.app_secret = 'APP_SECRET'
+    end
+  end
+
+  config.before(:each) do
+    stub_request(:any, /mifiel.com/).to_rack(FakeMifiel)
+  end
 end

data/spec/support/fake_mifiel.rb

@@ -0,0 +1,68 @@
+require 'sinatra/base'
+
+class FakeMifiel < Sinatra::Base
+  get '/api/v1/documents' do
+    content_type :json
+    status 200
+    [
+      document,
+      document
+    ].to_json
+  end
+
+  post '/api/v1/documents' do
+    content_type :json
+    status 200
+    document(
+      id: params[:id],
+      original_hash: Digest::SHA256.hexdigest(params[:file][:tempfile].read),
+      file_file_name: params[:file][:filename],
+      signed: false,
+      signed_at: nil
+    ).to_json
+  end
+
+  post '/api/v1/documents/:id/sign' do
+    content_type :json
+    status 200
+    document(
+      id: params[:id]
+    ).to_json
+  end
+
+  private
+
+    def document(args={})
+      id = args[:id] || SecureRandom.uuid
+      {
+        id: id,
+        original_hash: Digest::SHA256.hexdigest(id),
+        file_file_name: 'test-pdf.pdf',
+        signed_by_all: true,
+        signed: true,
+        signed_at: Time.now.utc.iso8601,
+        status: [1, 'Firmado'],
+        owner: {
+          email: 'signer1@email.com',
+          name: 'Jorge Morales'
+        },
+        file: "/api/v1/documents/#{id}/file",
+        file_download: "/api/v1/documents/#{id}/file?download=true",
+        file_signed: "/api/v1/documents/#{id}/file_signed",
+        file_signed_download: "/api/v1/documents/#{id}/file_signed?download=true",
+        file_zipped: "/api/v1/documents/#{id}/zip",
+        signatures: [{
+          email: 'signer1@email.com',
+          signed: true,
+          signed_at: (Time.now.utc - 10_000).iso8601,
+          certificate_number: '20001000000200001410',
+          tax_id: 'AAA010101AAA',
+          signature: '77cd5156779c..4e276ef1056c1de11b7f70bed28',
+          user: {
+            email: 'signer1@email.com',
+            name: 'Jorge Morales'
+          }
+        }]
+      }
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mifiel
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Genaro Madrid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-09 00:00:00.000000000 Z
+date: 2016-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -194,6 +194,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.22.2
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
 description: 
 email:
 - genmadrid@gmail.com
@@ -207,6 +241,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -225,6 +260,7 @@ files:
 - spec/fixtures/example.pdf
 - spec/mifiel/document_spec.rb
 - spec/spec_helper.rb
+- spec/support/fake_mifiel.rb
 homepage: https://github.com/Mifiel/ruby-api-client
 licenses:
 - MIT
@@ -255,3 +291,4 @@ test_files:
 - spec/fixtures/example.pdf
 - spec/mifiel/document_spec.rb
 - spec/spec_helper.rb
+- spec/support/fake_mifiel.rb