xolphin-api 1.5.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8f790957461ab10603a64a29989e326f0cbd082b
-  data.tar.gz: 0af1d2247200cd535fc67468738c4dcbe4ca363f
+SHA256:
+  metadata.gz: 6ea86464949998e7872f71f61ef5b469c35dfb068cec1ac3e21adb8fdfed6d94
+  data.tar.gz: b343eac1cdfd1560dbd838a380c81a83ad2ea224f225480f23a7cc95ce7a41f7
 SHA512:
-  metadata.gz: e0ab8d6c3bac39af024cc3e8d79012159a4902e7f7eff884e082aa0c1709a099f342ab8d10cb63b70f9fc290bda97533763e912eb8cd8754a4713660a7d33469
-  data.tar.gz: 5a6f3cf58d25bf9ea11a57e0ee22d6bd646642fc82a6edc87c1c9eabf58cf10311f13f8b56c09b56d84e32cbd8e1fd7f3991e53c021670c03a2b6b0470cd7cea
+  metadata.gz: 7a8cddc0663d80351cd355641961950f7921ca0e130552d29436665b8f9f2f223d996cb16f5a50b5f69d86ac585a8e238b507241f2cdc7cbdcd7a9abd56fa0f0
+  data.tar.gz: '06923d52ba80d5a18019acf3f62e716bc34d0875ab2c6b3ba43650969c211cf428fca678d9fc351768d0e4519d4a2763401a3b817e1674737fb80372507bf029'

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -1,28 +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
+# 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

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

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+## [1.8.0] - 2020-03-02
+### Added
+- Certificate Requests: Support the new validation information from Comodo
+- Certificate Requests: Added method for cancelling a request
+- Certificate Requests: Added some missing properties
+- Certificate Requests: Added support for scheduling validation calls
+- Invoices: Added invoices endpoints
+
+## [1.5.0] - 2017-06-07
+### Added
+- Certificates: Reissue and renewal of certificates
+- Certificate Requests: Get and send notes linked to an order
+- Certificate Requests: Send Subscriber Agreement
+- Certificate Requests: Resend DCV email
+- Certificate Requests: You can now send a language parameter with the request, which will be used for (eg) the Subscriber Agreement
+- Certificate Requests: A new field 'brandValidation' is added, which is used to indicate if the request is being held for review due to specific brand names

data/Gemfile

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

data/LICENSE.txt

@@ -1,21 +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.
+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

@@ -1,169 +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).
+# 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 Sectigo (formely 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

@@ -1,12 +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]
+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

@@ -1,14 +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
+#!/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

@@ -1,8 +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
+#!/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

@@ -1,8 +1,9 @@
-class Credentials
-	def self.username 
-		'nikita@xolphin.nl'
-	end
-	def self.password 
-		'test1234'
-	end
-end
+class Credentials
+  def self.username
+    '<your-username>'
+  end
+
+  def self.password
+    '<your-super-secure-password>'
+  end
+end

data/examples/certificate_cancel.rb

@@ -1,6 +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
+require_relative "../lib/xolphin/api"
+require_relative "credentials"
+
+client = Xolphin::Api::Client.new(Credentials.username, Credentials.password, true)
+result = client.certificate.cancel(960_003_013, 'idk', false)
+puts result.inspect