viafirma-api 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODUzMjQyZWYzOTkzMTBkZWQ4YTBlM2EzNTA3NTU5ZmMyZTE4YjE3ZA==
+  data.tar.gz: !binary |-
+    ZjRjYTUwZWY0YmQzNDQ4MDMzNjZjNTBmNWNkNTBmY2Y1MjA5YmNmYw==
+SHA512:
+  metadata.gz: !binary |-
+    YTliZjMyYzkwZmJmYTYzNjhhZGY4N2ZkMTVlNWZlZWI1Yzg4NGFjODJmZGZm
+    YjA3MzE4YTU3NzQyNDA1ZjgyMzA4YjU0NTk3NWM5ZWFhNDg5ODNiNmZjZGI1
+    NzQ1NmVkZmNjNTM1OGZlMmU0NWMzM2ZjMmIxYWQ2MzAyYTI5MDA=
+  data.tar.gz: !binary |-
+    MmFiNDU1OTM0MjQ3MjAyZDBlNzk1ZTAxMWU1ZTY5MjE5OTI4NjQyMzE3ZGQ1
+    ZDE1ZjRjZWZkYWRlN2QxYTA1ZjBhNzY5MWMxNWVjYTZkMGIxZjU3NzRiYTBl
+    Y2NlZDEwOTgzYzMyNDQyMDlmZmFlNWY2YzI5NWIxNjE1YTc1NTc=

data/.gitignore

@@ -0,0 +1 @@
+lib/viafirma/config.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in viafirma-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    viafirma-api (0.0.1)
+      activesupport (~> 3.2)
+      savon (~> 2.11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
+    builder (3.2.2)
+    columnize (0.9.0)
+    debugger (1.6.8)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.3.5)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.3.8)
+    diff-lcs (1.2.5)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    httpi (2.4.2)
+      rack
+      socksify
+    i18n (0.6.9)
+    mini_portile2 (2.0.0)
+    multi_json (1.9.2)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    nori (2.6.0)
+    rack (1.6.4)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    savon (2.11.1)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (~> 2.3)
+      nokogiri (>= 1.4.0)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
+    socksify (1.7.0)
+    wasabi (3.5.0)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  debugger (~> 1.6)
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  viafirma-api!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 David García
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Viafirma::Api
+
+API for connect and manage e-sign with viafirma platform
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'viafirma-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install viafirma-api
+
+## Usage
+
+Viafirma API facade initialization:
+
+    facade = Viafirma::Api::Facade.new(server: <address>, user: <username>, apikey: <apikey>)
+    
+By default the gem will use the port 80 for the requests, but you can change it with aditional parameter in the initialization hash (`port: <portnumber>`)
+
+### Ping
+For testing the connection with the API you can call the ping method of the facade
+
+    facade.ping
+the response should be a Hash like this:
+
+    {:error=>false, :message=>nil, :response_code=>"SUCCESS", :result=>"pingResponse"}
+
+### Prepare sign request
+This method will throw the sign process throught the viafirma platform
+
+    facade.prepare_sign_request(<personId>, <documentName>, <documentContent>, <returnURL>)
+
+`personId`: Viafirma person id of active user that will sign.
+
+`documentName`: Name of the document to sign.
+
+`documentContent`: Binary content of the document to sign.
+
+`returnURL`: Return url where the Viafirma will redirect after the sign request with the result of the sign.
+
+The server response Hash for the call should include a redirectURL with the url where the user will sign the document.
+
+### Other methods
+
+For other methods of the API you can use it with the 'raw' savon call method and do dirty things :)
+    
+    facade.call(:get_request_info, message: { request_id: <requestId> })
+The first parameter is the method name, and the last is a message payload hash with the request parameters. 
+
+For further info check the [viafirma developers](https://developers.viafirma.com/en) page
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/viafirma-api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/viafirma/api/client.rb

@@ -0,0 +1,41 @@
+require 'savon'
+
+module Viafirma
+  module Api
+    class Client
+
+      def initialize(credentials)
+        validate(credentials)
+        @client = Savon.client(wsdl: self.class.wsdl(credentials), basic_auth: [credentials[:user], credentials[:apikey]])
+      end
+
+      def self.wsdl(credentials)
+        "http://#{credentials[:server]}:#{credentials[:port] || 80}/inbox/serviceWS?wsdl"
+      end
+
+      def call(*args)
+        response = @client.call(*args)
+        parse_response(response.body)
+      end
+
+      def parse_response(response)
+        response_key = response.keys.detect{|k,v| k.to_s.end_with?('_response')}
+        data = response[response_key][:return]
+      
+        if data[:error]
+          raise "#{data[:response_code]}: #{data[:message]}"
+        else
+          data
+        end
+      end
+
+      private
+
+      def validate(credentials)
+        raise "Server endpoint missing!!" if credentials[:server].blank?
+        raise "User can't be blank!!" if credentials[:user].blank?
+        raise "Apikey can't be blank!!" if credentials[:apikey].blank?
+      end
+    end
+  end
+end

data/lib/viafirma/api/version.rb

@@ -0,0 +1,5 @@
+module Viafirma
+  module Api
+    VERSION = "0.0.1"
+  end
+end

data/lib/viafirma/facade.rb

@@ -0,0 +1,30 @@
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/module/delegation'
+
+module Viafirma
+  module Api
+    class Facade
+      delegate :call, to: :@client
+      
+      def initialize(credentials)
+        @client = Client.new(credentials.with_indifferent_access)
+      end
+
+      def ping
+        @client.call(:ping, message: { param: 'pingResponse' })
+      end
+
+      def prepare_sign_request(person_id, document_name, document_content, return_url, metadata={})
+        params = {
+          person_id: person_id,
+          document_name: document_name,
+          document_content: Base64.encode64(document_content),
+          return_url: return_url,
+          metadatos: metadata
+        }
+        @client.call(:prepare_sign_request, message: params)
+      end
+
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+require 'viafirma/api/client'
+
+describe Viafirma::Api::Client do
+
+  let(:config){ { server: 'whatever', port: 11, user: 'test', apikey: '123' } }
+  let(:client){ Viafirma::Api::Client }
+
+  describe "#initialize" do
+    it "should build a well formed client" do
+      expect{ client.new(config) }.to_not raise_error
+    end
+
+    context "invalid config" do   
+      it "should raise error if server not specified" do
+         expect{ client.new(config.merge(server: nil)) }.to raise_error(RuntimeError, /server/i)
+      end
+
+      it "should raise error if user not specified" do
+        expect{ client.new(config.merge(user: nil)) }.to raise_error(RuntimeError, /user/i)
+      end
+
+      it "should raise error if apikey not specified" do
+        expect{ client.new(config.merge(apikey: nil)) }.to raise_error(RuntimeError, /apikey/i)
+      end
+    end
+  end
+
+  describe "#call" do
+    let(:response_body){ {:ping_response=>{:return=>{:error=>false, :message=>nil, :response_code=>"SUCCESS", :result=>"pingResponse"}, :"@xmlns:ns2"=>"http://tray.viavansi.com"}} }
+    let(:response){ double("Savon::Response", :body => response_body) }
+    let(:savon_client){ double("Savon::Client") }
+
+    before(:each){ allow(Savon).to receive(:client).and_return(savon_client) }
+
+    it "should invoke savon call method with the same args" do
+      c = client.new(config)
+      expect(savon_client).to receive(:call).with(:ping, message: {param: 'pingResponse'}).and_return(response)
+      c.call(:ping, message: {param: 'pingResponse'})
+    end
+
+    it "should parse response" do
+      c = client.new(config)
+      allow(savon_client).to receive(:call).and_return(response)
+      expect(c).to receive(:parse_response).with(response_body)
+      c.call(:ping)
+    end
+  end
+
+  describe "#parse_response" do
+
+    it "should return the result for valid responses" do
+      response_body = {:method_response=>{:return=>{:error=>false, :message=>nil, :response_code=>"SUCCESS", :result=>"methodResponse"}, :"@xmlns:ns2"=>"http://tray.viavansi.com"}}
+      expect(client.new(config).parse_response(response_body)).to eq response_body[:method_response][:return]
+    end
+
+    it "should raise error with a message" do
+      error_response = {:method_response=>{:return=>{:error=>true, :message=>"I'm a error!", :response_code=>"ERROR_0"}, :"@xmlns:ns2"=>"http://tray.viavansi.com"}}
+      expect{client.new(config).parse_response(error_response)}.to raise_error("ERROR_0: I'm a error!")
+    end
+  end
+
+  describe ".wdsl" do
+    it "should build wdsl url for viafirma platform" do
+      expect(client.wsdl(config)).to eq("http://whatever:11/inbox/serviceWS?wsdl")
+    end
+
+    it "should use port 80 by default" do
+      expect(client.wsdl(config.merge(port: nil))).to eq("http://whatever:80/inbox/serviceWS?wsdl")
+    end
+  end
+
+end

data/spec/facade_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'viafirma/facade'
+
+describe Viafirma::Api::Facade do
+
+  let(:facade){ Viafirma::Api::Facade }
+
+  describe "#prepare_sign_request" do
+
+    let(:client){ double("Client") }
+    before(:each){ allow(Viafirma::Api::Client).to receive(:new).and_return(client) }
+
+    it "should encode document content before send the soap request" do
+      allow(client).to receive(:call).with(:prepare_sign_request, message: hash_including(document_content: Base64.encode64('content')))
+      facade.new({}).prepare_sign_request('1234', 'name', 'content', 'return.url', {metadata_key: 'metadata_value'})
+    end
+
+    #IMPORTANT IF THE KEY IS NOT PRESENT THE API RESPONDS WITH NULLPOINTEREXCEPTION!!
+    it "should include 'metadatos' in the soap request even if it's empty" do
+      allow(client).to receive(:call).with(:prepare_sign_request, message: hash_including(metadatos: {}))
+      facade.new({}).prepare_sign_request('1234', 'name', 'content', 'return.url')
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,98 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'ruby-debug'
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/viafirma-api.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'viafirma/api/version'
+require 'viafirma/api/client'
+require 'viafirma/facade'
+
+
+Gem::Specification.new do |spec|
+  spec.name          = "viafirma-api"
+  spec.version       = Viafirma::Api::VERSION
+  spec.authors       = ["David García Lorigados"]
+  spec.email         = ["dglo1985@gmail.com"]
+  spec.summary       = %q{API for connect and manage e-sign with viafirma platform}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", '~> 3.4'
+  spec.add_development_dependency "debugger", '~> 1.6'
+
+  spec.add_dependency "savon", '~> 2.11'
+  spec.add_dependency "activesupport", '~> 3.2'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: viafirma-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David García Lorigados
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: ''
+email:
+- dglo1985@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/viafirma/api/client.rb
+- lib/viafirma/api/version.rb
+- lib/viafirma/facade.rb
+- spec/client_spec.rb
+- spec/facade_spec.rb
+- spec/spec_helper.rb
+- viafirma-api.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: API for connect and manage e-sign with viafirma platform
+test_files:
+- spec/client_spec.rb
+- spec/facade_spec.rb
+- spec/spec_helper.rb