ecertic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f474f1fb935efa9d8870e6e6ea6827216a8aa186f68f4953cf58debb9becc27f
+  data.tar.gz: 6789fc22f2fd40460ba1dc25ec1af6ba391d791f56010d10c604146b376d93ed
+SHA512:
+  metadata.gz: ecd828b6c9b0d42a1b485ac04e7606c1ee0a4349478e26b01ae0deb60fee3eeb837ed685ee92fb1e83e442fd6175d18d27a6de3506c395407cb4cb94627b3880
+  data.tar.gz: 46f8de6fb07bcb79d7679f3c6c6a06af0931a25be685acf1a5c3aac3ce622de81dea7d596a11e0468bea6c9f1c41c852716294810a70c5ebb7d97f99e68a35aa

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,46 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/IndentFirstArrayElement:
+  EnforcedStyle: consistent
+
+Layout/IndentFirstHashElement:
+  EnforcedStyle: consistent
+
+Metrics/LineLength:
+  # Commonly used screens these days easily fit more than 80 characters.
+  Max: 120
+  Exclude:
+    - "spec/**/*.rb"
+
+# [codesmell]
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 50
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+- 2.6.3
+before_install: gem install bundler -v 2.0.2
+notifications:
+  slack:
+    secure: faQfcCuUCq1psgiPZar9zajFU/C/o+Xs0CVOOqOQd/m43D4AvEeD/KEFnZEEjBW6ILzg9n7lf3AeE5MYwIkgTrieDKAEVQ1Rnl0qFJKwS9bjkEoqqrO2fGQJ8N/dTfA3BIsgrUgTZF3CoxqkIN1QKvtbSiWuao0ZHr4KnkBwA2P4m/G8CTMXzup4b2aX+B6P84UZgDMXdmeTNIuC/C7iXlpPCTcNaCO7EeB59IUP/WM6my4ynKpsa80wAz4HsALMh+oNRwE20EmYIK8L4ecn7PZitTeSZWuiPjWTHYrU1+05cM9tRQzP8r6FohRAfGTzUgC0cyMqxHN3uMwj4XMHE1hlnF6BP7BA5BbQSKkEIiwS8ao4k008nMYT0gplVZDxZ7lQpVOXVcIsEiPtYVJ2tayLhFS00H7HonppHwYhXTWnt2W4RHKjnkSiVj66/eBCaca9l59nP5oAxWvAVpa1lIZl2a/Gzv/mEDdCupIJmIXZiSz/sCDg5kQr/MhGdua3mniurCN1VIwpBGilO/hYSLoW0GNj5/bw3LLS1lVIaI4Q6Lm7dxQJKyayDVhDhhFBMZ79tUweZM9YFmsDE/8QWbCH6tZ/ZjubHi6PAgMAPgleSR5AxWPlCVP/YnBo1qpQOQ1qIRPmDlllgnefpG4kAfa/qSnvLfcLQW3AFJyGYEk=

data/CHANGELOG

@@ -0,0 +1 @@
+#### Release 0.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at dev@devengo.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Devengo SL
+
+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,74 @@
+# Ecertic
+
+Non-official Ruby client for Ecertic OTP API <https://docs.otpsecure.net/>. It provides the necessary scaffolding to easily upload a PDF file to Ecertic's API and request the delivery of an OTP to a given phone for its validation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ecertic'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install ecertic
+```
+
+## Usage
+
+```ruby
+
+require "ecertic"
+
+client = Ecertic::Client.new(apikey: "APIKEY", secret: "SECRET")
+
+info = {
+  sandbox: true,
+  movil: "669010101",
+  smsusr: "smsusr",
+  smspwd: "smspwd",
+  pdf_files: [File.open("contract.pdf")],
+}
+
+request = client.otps.create(info)
+# request.token => "d98509b2aa....3cff10a8b47"
+# request.uuid => "rJwJnaKXS"
+# In the sandbox environment you will get the OTP itself too
+# request.otp => "147548"
+
+status = client.otps.status(request.token)
+# request.status => "SANDBOX"
+# request.sandbox? => true
+# request.sent? => false
+
+validation = client.tokens.validate(request.token, request.otp)
+# request.status => "OTP_OK"
+# request.ok? => true
+# request.message => "OTP CORRECTA"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests or if you prefer auto reloading specs run `bundle exec guard`. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/devengoapp/ecertic-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ecertic project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/devengoapp/ecertic-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ecertic"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ecertic.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ecertic/version"
+
+Gem::Specification.new do |spec|
+  spec.version       = Ecertic::VERSION
+  spec.name          = "ecertic"
+  spec.summary       = "Non-official Ruby bindings for the Ecertic API"
+  spec.description   = "Ecertic provides digital signature and KYC services."
+  spec.homepage      = "https://www.ecertic.com/"
+  spec.authors       = ["Devengo"]
+  spec.email         = ["dev@devengo.com"]
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.3.0"
+
+  spec.metadata = {
+    "homepage_uri"    => spec.homepage,
+    "bug_tracker_uri" => "https://github.com/devengoapp/ecertic-ruby/issues",
+    "changelog_uri"   => "https://github.com/devengoapp/ecertic-ruby/blob/master/CHANGELOG.md",
+    "github_repo"     => "ssh://github.com/devengoapp/ecertic-ruby",
+    "source_code_uri" => "https://github.com/devengoapp/ecertic-ruby",
+  }
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("faraday", "~> 0.13")
+  spec.add_runtime_dependency("faraday_middleware", "~> 0.13")
+  spec.add_runtime_dependency("net-http-persistent", "~> 3.0")
+
+  spec.add_development_dependency("bundler", "~> 2.0")
+  spec.add_development_dependency("rake", "~> 10.0")
+  spec.add_development_dependency("rspec", "~> 3.0")
+  spec.add_development_dependency("webmock", "~> 3.6")
+  spec.add_development_dependency("guard", "~> 2.15")
+  spec.add_development_dependency("guard-rspec", "~> 4.7")
+end

data/lib/ecertic.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "faraday_middleware"
+require "logger"
+require "base64"
+require "json"
+
+require "ecertic/version"
+require "ecertic/api"
+
+require "ecertic/resources/base"
+require "ecertic/resources/document"
+require "ecertic/resources/statusable"
+require "ecertic/resources/otp/request"
+require "ecertic/resources/otp/status"
+require "ecertic/resources/token/instance"
+require "ecertic/resources/token/validation"
+
+require "ecertic/errors"
+require "ecertic/default"
+require "ecertic/callback"
+require "ecertic/utils"
+require "ecertic/response"
+require "ecertic/client"
+
+module Ecertic
+  @api_base = "https://api.otpsecure.net/"
+
+  @log_level = nil
+  @logger = nil
+
+  LEVEL_DEBUG = Logger::DEBUG
+  LEVEL_ERROR = Logger::ERROR
+  LEVEL_INFO = Logger::INFO
+
+  class << self
+    attr_accessor :api_base, :api_key, :secret
+  end
+
+  def self.log_level
+    @log_level
+  end
+
+  def self.log_level=(val)
+    # Support text values for easy log level definition from command line via export
+    val = case val
+          when "debug"
+            LEVEL_DEBUG
+          when "info"
+            LEVEL_INFO
+          else
+            val
+          end
+    if !val.nil? && ![LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO].include?(val)
+      raise ArgumentError,
+            "log_level should only be set to `nil`, `debug` or `info`"
+    end
+    @log_level = val
+  end
+
+  def self.logger
+    @logger
+  end
+
+  def self.logger=(val)
+    @logger = val
+  end
+end
+
+Ecertic.log_level = ENV["ECERTIC_LOG"] unless ENV["ECERTIC_LOG"].nil?

data/lib/ecertic/api.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "ecertic/api/service"
+require "ecertic/api/documents_service"
+require "ecertic/api/otps_service"
+require "ecertic/api/tokens_service"
+
+module Ecertic
+  module API
+    def otps
+      @services[:otps] ||= API::OTPsService.new(self)
+    end
+
+    def tokens
+      @services[:tokens] ||= API::TokensService.new(self)
+    end
+
+    def documents
+      @services[:documents] ||= API::DocumentsService.new(self)
+    end
+  end
+end
+