xolphin-api 1.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f790957461ab10603a64a29989e326f0cbd082b
+  data.tar.gz: 0af1d2247200cd535fc67468738c4dcbe4ca363f
+SHA512:
+  metadata.gz: e0ab8d6c3bac39af024cc3e8d79012159a4902e7f7eff884e082aa0c1709a099f342ab8d10cb63b70f9fc290bda97533763e912eb8cd8754a4713660a7d33469
+  data.tar.gz: 5a6f3cf58d25bf9ea11a57e0ee22d6bd646642fc82a6edc87c1c9eabf58cf10311f13f8b56c09b56d84e32cbd8e1fd7f3991e53c021670c03a2b6b0470cd7cea

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version
+.ruby-gemset
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,28 @@
+# Xolphin-API RuboCop configuration
+
+AllCops:
+  TargetRubyVersion: 2.2
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.5
+before_install: gem install bundler -v 1.13.6

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xolphin-api.gemspec
+gemspec
+
+gem 'rubocop', '~> 0.45.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kentaa
+
+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,169 @@
+# Xolphin API gem for Ruby
+xolphin-api-ruby is a library which allows quick integration of the [Xolphin REST API](https://api.xolphin.com) in Ruby to automated ordering, issuance and installation of SSL Certificates.
+
+## About Xolphin
+[Xolphin](https://www.xolphin.nl/) is the largest supplier of [SSL Certificates](https://www.sslcertificaten.nl) and [Digital Signatures](https://www.digitalehandtekeningen.nl) in the Netherlands. Xolphin has
+a professional team providing reliable support and rapid issuance of SSL Certificates at an affordable price from industry leading brands such as Comodo, GeoTrust, GlobalSign, Thawte and Symantec.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'xolphin-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xolphin-api
+
+## Usage
+
+### Client initialization
+
+```ruby
+require 'xolphin/api'
+
+client = Xolphin::Api::Client.new('<username>', '<password>')
+```
+
+### Requests
+
+#### Getting list of requests
+
+```ruby
+requests = client.request.all
+requests.each do |request|
+  puts request.id, request.product.id
+end
+```
+
+#### Getting request by ID
+
+```ruby
+request = client.request.get(960000024)
+puts request.product.brand
+```
+
+#### Requesting certificate
+
+```ruby
+ccr = client.request.create(24, 1, 'csr string', Xolphin::Api::DcvType::EMAIL)
+ccr.address = 'Address'
+ccr.approver_first_name = 'FirstName'
+ccr.approver_last_name = 'LastName'
+ccr.approver_phone = '+12345678901'
+ccr.approver_email = 'email@domain.com'
+ccr.zipcode = '123456'
+ccr.city = 'City'
+ccr.company = 'Company'
+ccr.subject_alternative_names = ['test1.domain.com', 'test2.domain.com']
+ccr.dcv = [{
+  'domain' => 'test1.domain.com',
+  'dcvType' => Xolphin::Api::DcvType::EMAIL,
+  'approverEmail' => 'email@domain.com'
+}]
+
+request = client.request.send(ccr)
+puts request.id
+```
+
+#### Reissue certificate
+
+```ruby
+certificate = client.certificate.get(<certificate_id>);
+request = Xolphin::Api::CertificateRequests::ReissueCertificateRequest.new(<csr_string>,"EMAIL")
+client.certificate.reissue(certificate.id, request)
+```
+
+#### Renew certificate
+
+```ruby
+certificate = client.certificate.get(<certificate_id>);
+request = Xolphin::Api::CertificateRequests::RenewCertificateRequest.new(certificate.product.id, <years>, <csr_string>, 'FILE')
+client.certificate.renew(certificate.id, request)
+```
+
+#### Create a note
+
+```ruby
+result = client.request.sendNote(1234, 'message')
+```
+
+#### Get list of notes
+
+```ruby
+result = client.request.getNotes(1234)
+result.notes.each do |note|
+  puts note.message_body, note.created_at
+end
+```
+
+#### Send a "Comodo Subscriber Agreement" email
+
+```ruby
+# currently available languages: en, de, fr, nl
+result = client.request.sendComodoSAEmail(1234, 'email@example.com', '<language>');
+```
+
+#### Request an "Encryption Everywhere" certificate
+```ruby
+request = client.request.createEE
+request.csr = "<csr_string>"
+request.approver_first_name = "FirstName"
+request.approver_last_name = "LastName"
+request.approver_phone = "+1234567890"
+request.approver_email = "email@domain.com"
+request.subject_alternative_names = ["test1.domain.com", "test2.domain.com"]
+request.dcv_type = "FILE"
+response = client.request.sendEE(request)
+```
+
+### Certificate
+
+#### Certificates list and expirations
+
+```ruby
+certificates = client.certificate.all
+certificates.each do |certificate|
+  puts certificate.id, certificate.expired?
+end
+```
+
+#### Download certificate
+
+```ruby
+certificate = client.certificate.download(960000031, Xolphin::Api::FormatType::CRT)
+File.write('crt.crt', certificate)
+```
+
+### Support
+
+#### Products list
+
+```ruby
+products = client.support.products
+products.each do |product|
+  puts product.id, product.brand
+end
+```
+
+#### Decode CSR
+
+```ruby
+data = client.support.decode_csr('csr string')
+puts data.type, data.size
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xolphin/xolphin-api-ruby.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+# Endpoint specs make an actual HTTP requests so we exclude them from CI.
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--tag ~endpoint"
+end
+
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:spec, :rubocop]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xolphin/api"
+
+# 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

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/examples/_credentials.rb

@@ -0,0 +1,8 @@
+class Credentials
+	def self.username 
+		'nikita@xolphin.nl'
+	end
+	def self.password 
+		'test1234'
+	end
+end

data/examples/certificate_cancel.rb

@@ -0,0 +1,6 @@
+require_relative "../lib/xolphin/api"
+require_relative "credentials"
+
+client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, true)
+result = client.certificate.cancel(960003013, 'idk', false);
+puts result.inspect

data/examples/certificate_reissue.rb

@@ -0,0 +1,25 @@
+require_relative "../lib/xolphin/api"
+
+email = '<email>';
+
+client = Xolphin::Api::Client.new(Credentials.username, Credentials.password)
+certificate = client.certificate.get(950000487);
+request = Xolphin::Api::CertificateRequests::ReissueCertificateRequest.new("-----BEGIN CERTIFICATE REQUEST-----
+MIICzDCCAbQCAQAwgYYxCzAJBgNVBAYTAkJSMQ0wCwYDVQQIDAR0ZXN0MQ0wCwYD
+VQQHDAR0ZXN0MQ0wCwYDVQQKDAR0ZXN0MQ0wCwYDVQQLDAR0ZXN0MRswGQYDVQQD
+DBJleGNoYW5nZS5taGltZWUubmwxHjAcBgkqhkiG9w0BCQEWD3BpemRhQGdtYWls
+LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMfH+piYuiOBlGSS
+wN0R9MuMqWa6XbUE4dwjzbCcocoqW4cLC9SWpHoYjwlSpsuyJNrzxe5rwiiyNGUi
+Unm+HrY1+ADa+sCQhL2+siPd6nIZeNWrC6Zw1KDaAVWmm8x2gZb7+aDyA7l35BHB
+2LJ2tbgvcpLr8dOcN4f0DI719eEM5QtpYvf5YVEKCrAizirwFhx4xjPVW4jHsM1G
+wb0f115+HJgB69cign5XCKykqZ2lmJpzfZ1DQ7vU2MyRzxukD1QQy8aDf5w3lmlY
+baB1ofchJ5YiLO7Y0fxW18J6zEbfrsHgECQ29COpojNsdDy30Vt9g5br89EzdZlb
+End4NRsCAwEAAaAAMA0GCSqGSIb3DQEBBQUAA4IBAQBuOIZ4R6kfC5b7p8SOwXkS
+Q/g93311lGT7ArKn/XyFFrTEtYa3SN9QotaIgNxG6gXxgh/LD8g8w9q3wYswayzY
+cz6+5YjfblHcrWJ5zwVrKyD+8QLuC5xhrEFBBmYjzxihjAWkYtvaC4YKuo1PxESs
+RFlZosJFLIZpToXnGUfc5HgaI1/270plv57+1nOP4r+129d9r94z8sNDZACyi7Mp
+mHc7dQXFcmnyCk3PW9uwqU13pT08yrRHRTOTB25DkGqNG8IHtv9XJqfL1u7/FJil
+7W7eDOdoDXRHBZX9RlEZlekHE7kpziH7E7517BOX/RTmGLLQRmqPiZWkU8eWzHCl
+-----END CERTIFICATE REQUEST-----", 'EMAIL')
+request.approver_email = "test@gmail.com"
+puts client.certificate.reissue(certificate.id, request).inspect

data/examples/certificate_renew.rb

@@ -0,0 +1,22 @@
+require_relative "../lib/xolphin/api"
+
+client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, true)
+certificate = client.certificate.get(950000487);
+request = Xolphin::Api::CertificateRequests::RenewCertificateRequest.new(certificate.product.id, 1, "-----BEGIN CERTIFICATE REQUEST-----
+MIICzDCCAbQCAQAwgYYxCzAJBgNVBAYTAkJSMQ0wCwYDVQQIDAR0ZXN0MQ0wCwYD
+VQQHDAR0ZXN0MQ0wCwYDVQQKDAR0ZXN0MQ0wCwYDVQQLDAR0ZXN0MRswGQYDVQQD
+DBJleGNoYW5nZS5taGltZWUubmwxHjAcBgkqhkiG9w0BCQEWD3BpemRhQGdtYWls
+LmNvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMfH+piYuiOBlGSS
+wN0R9MuMqWa6XbUE4dwjzbCcocoqW4cLC9SWpHoYjwlSpsuyJNrzxe5rwiiyNGUi
+Unm+HrY1+ADa+sCQhL2+siPd6nIZeNWrC6Zw1KDaAVWmm8x2gZb7+aDyA7l35BHB
+2LJ2tbgvcpLr8dOcN4f0DI719eEM5QtpYvf5YVEKCrAizirwFhx4xjPVW4jHsM1G
+wb0f115+HJgB69cign5XCKykqZ2lmJpzfZ1DQ7vU2MyRzxukD1QQy8aDf5w3lmlY
+baB1ofchJ5YiLO7Y0fxW18J6zEbfrsHgECQ29COpojNsdDy30Vt9g5br89EzdZlb
+End4NRsCAwEAAaAAMA0GCSqGSIb3DQEBBQUAA4IBAQBuOIZ4R6kfC5b7p8SOwXkS
+Q/g93311lGT7ArKn/XyFFrTEtYa3SN9QotaIgNxG6gXxgh/LD8g8w9q3wYswayzY
+cz6+5YjfblHcrWJ5zwVrKyD+8QLuC5xhrEFBBmYjzxihjAWkYtvaC4YKuo1PxESs
+RFlZosJFLIZpToXnGUfc5HgaI1/270plv57+1nOP4r+129d9r94z8sNDZACyi7Mp
+mHc7dQXFcmnyCk3PW9uwqU13pT08yrRHRTOTB25DkGqNG8IHtv9XJqfL1u7/FJil
+7W7eDOdoDXRHBZX9RlEZlekHE7kpziH7E7517BOX/RTmGLLQRmqPiZWkU8eWzHCl
+-----END CERTIFICATE REQUEST-----", 'FILE')
+puts client.certificate.renew(certificate.id, request).inspect

data/examples/get_notes.rb

@@ -0,0 +1,9 @@
+require_relative "../lib/xolphin/api"
+require_relative "_credentials"
+
+client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, true)
+result = client.request.getNotes(960003015)
+puts result.inspect
+result.notes.each do |note|
+  puts note.message_body, note.created_at
+end

data/examples/request_create_ee.rb

@@ -0,0 +1,29 @@
+require_relative "../lib/xolphin/api"
+
+client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, true)
+request = client.request.createEE
+request.csr = "-----BEGIN CERTIFICATE REQUEST-----
+MIICuDCCAaACADB0MQswCQYDVQQGEwJOTDEWMBQGA1UEAxMNd3d3LnNzbGRldi5u
+bDEWMBQGA1UEBxMNSGVlcmh1Z293YWFyZDEQMA4GA1UEChMHWG9scGhpbjEWMBQG
+A1UECBMNTm9vcmQtSG9sbGFuZDELMAkGA1UECxMCSVQwggEiMA0GCSqGSIb3DQEB
+AQUAA4IBDwAwggEKAoIBAQDkTFMNKhWObiUH1xDeRcqYiROKvJZEI7njDlQbXeVC
+qSaBSBClJD98OSgE0+arnVyJ5Fnjkovgb9aC8HbWYbiD1tbWD+hKC1wPODEvknl7
+jfRpO36cIglIhftHn5p0k+f86uS2Nz1yr+5qwAEQ7C0UQZxMuBbzK6Uv8m0TbAVV
+CQ+i+uJfuXSsAT8LZbyoJsu50ZySG3uEhCSISh1cS/t/M2INHbXfzGA3GWH2FXCZ
+Qd9eLSBAVEanIr3TlRpNU3f0IDwJpm56BVTNtNL7GI2NilfUF9oSo9PSlPbAkPsN
+BrVdOiZgiOEO74rXE8fjA5Zm8uic6MyFRo4FuTUBWubrAgMBAAGgADANBgkqhkiG
+9w0BAQsFAAOCAQEAHuB6643oI7oPw5SbFQAcfTfQbyRTXNqwYOO8YRcCkDIu7aX9
+pupGvf+cSa5IDcZ6Dz22/Khp5rYlcutAtEN7d8MNBwBlcVzbWL+DuTU5ZWAxcRi4
+nmiw/C+RxFF+WsUcjwb+dNrTYkz03t7voMg/0NS7RRU/oTu8heDDcH+Ffam1bZJQ
+zi21dz/AsjG9Jc6GJqZs0ImEwCQlBhJYnXPj3FB8U/mzSWSfq502fdtmQrvIgHmI
+RLuxVO9QX0YLQ0ew1x2z+eFfBsfSI1+DkF4+5TrfJP6jQyHBR+VDdGYBO2d8rBw7
+ITIJC9tt2F4GjaPAI1xY9eoq/QfZxzNoNufMuw==
+-----END CERTIFICATE REQUEST-----"
+request.approver_first_name = "FirstName"
+request.approver_last_name = "LastName"
+request.approver_phone = "+1234567890"
+request.approver_email = "email@domain.com"
+request.subject_alternative_names = ["test1.domain.com", "test2.domain.com"]
+request.dcv_type = "FILE"
+response = client.request.sendEE(request)
+puts response.inspect

data/examples/request_validation_call.rb

@@ -0,0 +1,5 @@
+require_relative "../lib/xolphin/api"
+
+client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, true)
+result = client.request.scheduleValidationCall(960002992, "2017-05-01 13:00")
+puts result.inspect

data/examples/requests_get.rb

@@ -0,0 +1,7 @@
+require_relative "../lib/xolphin/api"
+
+client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, true)
+requests = client.request.all
+requests.each do |request|
+  puts request.id, request.product.id
+end

data/examples/send_csa_email.rb

@@ -0,0 +1,5 @@
+require_relative "../lib/xolphin/api"
+
+client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, true)
+result = client.request.sendComodoSAEmail(960003013, 'nikita@xolphin.nl');
+puts result.inspect

data/examples/send_note.rb

@@ -0,0 +1,6 @@
+require_relative "../lib/xolphin/api"
+require_relative "_credentials"
+
+client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, true)
+result = client.request.sendNote(960003015, 'note')
+puts result.inspect

data/lib/xolphin/api.rb

@@ -0,0 +1,32 @@
+require_relative "api/certificate_requests/create_certificate_request"
+require_relative "api/certificate_requests/create_ee_request"
+require_relative "api/certificate_requests/certificate_reissue"
+require_relative "api/certificate_requests/certificate_renew"
+
+require_relative "api/endpoint/certificate"
+require_relative "api/endpoint/request"
+require_relative "api/endpoint/support"
+
+require_relative "api/responses/base"
+require_relative "api/responses/certificate"
+require_relative "api/responses/certificates"
+require_relative "api/responses/csr_data"
+require_relative "api/responses/product_price"
+require_relative "api/responses/product"
+require_relative "api/responses/products"
+require_relative "api/responses/request_validation_domain"
+require_relative "api/responses/request_validation"
+require_relative "api/responses/request"
+require_relative "api/responses/request_ee"
+require_relative "api/responses/requests"
+require_relative "api/responses/note"
+require_relative "api/responses/notes"
+
+require_relative "api/client"
+require_relative "api/http"
+
+require_relative "api/dcv_type"
+require_relative "api/format_type"
+require_relative "api/product_type"
+
+require_relative "api/version"