mifiel 1.1.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f69a5effdcf36a00714f822894e9d8bae1575df
-  data.tar.gz: e4e318ac7d2bf6d08cfaa55e1d2c453136a28a03
+  metadata.gz: 1772670719d1f6b0a3701a741a365e1365aed0e5
+  data.tar.gz: 6c35a0f222ce5fe6d21d7559fb813a6f41f2a1c9
 SHA512:
-  metadata.gz: 2bd326f9cc687b91bc2d51cd5bafb7f055a6dd29e5a54ea5825be696f85e41ceb8130e9e35a82f216f64d218ef0465b1dabff910fc89c848b1920f8ddc44f4be
-  data.tar.gz: 6a7c20d3cba57c93b264d2114b8f23d231fa5fed876c6cdf2a4e4e16afa72a757642664ebb6d0a0b837057b4776d0c5f50b0c33db63201768e434c0ee35ad4ae
+  metadata.gz: dd0ca66ba48690fcfb88f5186293b0e8b4dcf1a96f2d903c5aa0f173ceecc6ba5cb5abbee468b567d21501707be7e23b73d7f3460506b509562cf05c8219a8b7
+  data.tar.gz: 22f6a6bb79aa959591450e0e7267e078e20d543e460b61b58995ca808b4720004c9ddcf6a4dd3f5efbe13699616bb25c07866214231d64871547a2f7139f90a4

data/lib/mifiel.rb

@@ -5,6 +5,7 @@ module Mifiel
   autoload :Base, 'mifiel/base'
   autoload :Document, 'mifiel/document'
   autoload :Certificate, 'mifiel/certificate'
+  autoload :Template, 'mifiel/template'
   autoload :Config, 'mifiel/config'
 
   BASE_URL = 'https://www.mifiel.com/api/v1'.freeze

data/lib/mifiel/document.rb

@@ -7,6 +7,8 @@ module Mifiel
     get :find, '/documents/:id'
     put :save, '/documents/:id'
     delete :delete, '/documents/:id'
+    post :create_from_template, '/templates/:template_id/generate_document', timeout: 60
+    post :create_many_from_template, '/templates/:template_id/generate_documents', timeout: 60
 
     # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
     def self.create(args)

data/lib/mifiel/template.rb

@@ -0,0 +1,22 @@
+module Mifiel
+  class Template < Mifiel::Base
+    get :all, '/templates'
+    get :find, '/templates/:id'
+    put :save, '/templates/:id'
+    post :create, '/templates'
+    delete :delete, '/templates/:id'
+
+    def generate_document(args = {})
+      Mifiel::Document.create_from_template(args.merge(template_id: id))
+    end
+
+    def generate_documents(callback_url:, identifier: nil, documents:)
+      Mifiel::Document.create_many_from_template(
+        template_id: template_id,
+        identifier: identifier,
+        documents: documents,
+        callback_url: callback_url
+      )
+    end
+  end
+end

data/lib/mifiel/version.rb

@@ -1,3 +1,3 @@
 module Mifiel
-  VERSION = '1.1.5'.freeze
+  VERSION = '1.2.0'.freeze
 end

data/mifiel.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '~> 2.1'
 
-  spec.add_runtime_dependency 'rest-client',        '>= 1.7'
-  spec.add_runtime_dependency 'json',               '> 0'
+  spec.add_runtime_dependency 'rest-client',        '>= 1.8'
+  spec.add_runtime_dependency 'json',               '~> 1.8'
   spec.add_runtime_dependency 'api-auth',           '~> 1.4'
   # Use Gem::Version to parse the Ruby version for reliable comparison
   # ActiveSupport 5+ requires Ruby 2.2.2
@@ -34,11 +34,11 @@ Gem::Specification.new do |spec|
   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 'byebug',     '~> 9.0',   '< 9.0.6'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4',   '>= 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.47.1'
-  spec.add_development_dependency 'simplecov',  '~> 0.11'
+  spec.add_development_dependency 'simplecov',  '~> 0.15'
 end

data/spec/mifiel/document_spec.rb

@@ -17,6 +17,52 @@ describe Mifiel::Document do
 
       it { expect(document).to be_a(Mifiel::Document) }
     end
+
+    context 'from template' do
+      let!(:template_id) { 'c6c29866-7fd6-4f77-9ecd-eae8bc3a772a' }
+      let!(:document) do
+        Mifiel::Document.create_from_template(
+          template_id: template_id,
+          fields: {
+            name: 'some'
+          },
+          signatories: [{
+            name: 'Signer',
+            email: 'signer@email.com'
+          }, {
+            name: 'Signer',
+            email: 'signer@email.com'
+          }]
+        )
+      end
+
+      it { expect(document).to be_a Mifiel::Document }
+    end
+
+    context 'many from template' do
+      let!(:template_id) { 'c6c29866-7fd6-4f77-9ecd-eae8bc3a772a' }
+      let!(:documents) do
+        Mifiel::Document.create_many_from_template(
+          template_id: template_id,
+          callback_url: 'http://some-callback.url/mifiel',
+          identifier: 'name',
+          documents: [{
+            fields: {
+              name: 'Some Name'
+            },
+            signatories: [{
+              name: 'Signer',
+              email: 'signer@email.com'
+            }, {
+              name: 'Signer',
+              email: 'signer@email.com'
+            }]
+          }]
+        )
+      end
+
+      it { expect(documents.status).to eq 'success' }
+    end
   end
 
   describe 'working with a document' do

data/spec/mifiel/template_spec.rb

@@ -0,0 +1,36 @@
+describe Mifiel::Template do
+  let!(:template_id) { 'bb7d65b4-47f1-470e-85e4-22ddae86f9ea' }
+
+  shared_examples 'a valid template' do
+    it { expect(template).to be_a(Mifiel::Template) }
+    it { expect(template).to respond_to(:id) }
+    it { expect(template).to respond_to(:name) }
+  end
+
+  describe '#create' do
+    let!(:template) do
+      Mifiel::Template.create(
+        name: 'Some Template',
+        content: '<div>Some <field name="name" type="string">NAME</field></div>',
+        header: 'Genaros Header',
+        footer: 'Genaros Footer'
+      )
+    end
+    it_behaves_like 'a valid template'
+  end
+
+  describe '#find' do
+    let!(:template) { Mifiel::Template.find(template_id) }
+
+    it_behaves_like 'a valid template'
+    it { expect(template.id).to eq(template_id) }
+  end
+
+  describe '#all' do
+    it 'should respond with many templates' do
+      templates = Mifiel::Template.all
+      expect(templates.count).to be > 0
+      expect(templates.first).to be_a(Mifiel::Template)
+    end
+  end
+end

data/spec/support/fake_mifiel.rb

@@ -10,6 +10,39 @@ class FakeMifiel < Sinatra::Base
     ].to_json
   end
 
+  get '/api/v1/templates' do
+    content_type :json
+    status 200
+    [
+      template,
+      template
+    ].to_json
+  end
+
+  get '/api/v1/templates/:id' do
+    content_type :json
+    status 200
+    template(id: params[:id]).to_json
+  end
+
+  post '/api/v1/templates' do
+    content_type :json
+    status 200
+    template.to_json
+  end
+
+  post '/api/v1/templates/:id/generate_documents' do
+    content_type :json
+    status 200
+    { status: :success }.to_json
+  end
+
+  post '/api/v1/templates/:id/generate_document' do
+    content_type :json
+    status 200
+    document(id: params[:id]).to_json
+  end
+
   post '/api/v1/keys' do
     content_type :json
     status 200
@@ -68,6 +101,14 @@ class FakeMifiel < Sinatra::Base
 
   private
 
+    def template(args = {})
+      {
+        id: args[:id] || SecureRandom.uuid,
+        name: 'some-template',
+        content: '<div><field name="name">NAME</field></div>'
+      }
+    end
+
     def key(args={})
       id = args[:id] || SecureRandom.uuid
       {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mifiel
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.0
 platform: ruby
 authors:
 - Genaro Madrid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-10 00:00:00.000000000 Z
+date: 2017-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: api-auth
   requirement: !ruby/object:Gem::Requirement
@@ -129,32 +129,32 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.1.7
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
-    - - ">="
+        version: '9.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 9.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
-    - - ">="
+        version: '9.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.10.1
+        version: 9.0.6
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.3.0
@@ -164,7 +164,7 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.4'
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.3.0
@@ -248,14 +248,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.15'
 description: 
 email:
 - genmadrid@gmail.com
@@ -280,6 +280,7 @@ files:
 - lib/mifiel/config.rb
 - lib/mifiel/document.rb
 - lib/mifiel/errors.rb
+- lib/mifiel/template.rb
 - lib/mifiel/version.rb
 - mifiel-ruby-api-client.sublime-project
 - mifiel.gemspec
@@ -289,6 +290,7 @@ files:
 - spec/mifiel/base_spec.rb
 - spec/mifiel/certificate_spec.rb
 - spec/mifiel/document_spec.rb
+- spec/mifiel/template_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_mifiel.rb
 homepage: https://www.mifiel.com
@@ -322,5 +324,6 @@ test_files:
 - spec/mifiel/base_spec.rb
 - spec/mifiel/certificate_spec.rb
 - spec/mifiel/document_spec.rb
+- spec/mifiel/template_spec.rb
 - spec/spec_helper.rb
 - spec/support/fake_mifiel.rb