https://github.com/pepabo/global_sign
A Ruby interface to the GlobalSign API.
https://github.com/pepabo/global_sign
client gem globalsign ruby
Last synced: about 1 year ago
JSON representation
A Ruby interface to the GlobalSign API.
- Host: GitHub
- URL: https://github.com/pepabo/global_sign
- Owner: pepabo
- License: mit
- Created: 2016-09-28T04:02:41.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T04:21:36.000Z (almost 2 years ago)
- Last Synced: 2025-03-28T14:43:16.059Z (about 1 year ago)
- Topics: client, gem, globalsign, ruby
- Language: Ruby
- Homepage:
- Size: 146 KB
- Stars: 23
- Watchers: 8
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# GlobalSign
[](https://badge.fury.io/rb/global_sign)
A Ruby interface to the [GlobalSign](https://www.globalsign.com/) API.
For more information and detailed documentation about the API visit [this page](https://www.globalsign.com/en/resources/apis/api-documentation/) .
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'global_sign'
```
And then execute:
```
$ bundle
```
Or install it yourself as:
```
$ gem install global_sign
```
## Usage
### Configuration
An example initializer would look something like this:
```ruby
GlobalSign.configure do |configuration|
configuration.user_name = 'PAR12345_taro'
configuration.password = 'password'
configuration.endpoint = 'https://test-gcc.globalsign.com/kb/ws/v1'
end
```
### URL Verification
```ruby
require 'global_sign'
client = GlobalSign::Client.new
# Prepare CSR beforehand
csr = <<-EOS
-----BEGIN CERTIFICATE REQUEST-----
...
-----END CERTIFICATE REQUEST-----
EOS
contract = GlobalSign::Contract.new(
first_name: 'Pepabo',
last_name: 'Taro',
phone_number: '090-1234-5678',
email: 'pepabo.taro@example.com',
)
request = GlobalSign::UrlVerification::Request.new(
product_code: 'DV_LOW_URL', # 'DV_HIGH_URL' or 'DV_LOW_URL'
order_kind: 'new', # If you request a new certificate
validity_period_months: 6,
csr: csr,
contract_info: contract,
)
response = client.process(request)
if response.success?
puts "Successfully URL Verification"
puts response.params # => { meta_tag: "xxxxx", ... }
else
raise StandardError, "#{response.error_code}: #{response.error_message}"
end
```
It's also possible to set contract within your configure block.
```ruby
GlobalSign.set_contract do |contract|
contract.first_name = 'Pepabo'
contract.last_name = 'Taro'
contract.phone_number = '090-1234-5678'
contract.email = 'pepabo.taro@example.com'
end
# Not need to give the argument 'contract_info'
request = GlobalSign::UrlVerification::Request.new(
product_code: 'DV_LOW_URL',
order_kind: 'new',
validity_period_months: 6,
csr: csr,
)
```
If you request a renewal certificate, you should set `renewal` to the value of argument `order_kind`.
And you should give the argument `renewal_target_order_id` .
```ruby
request = GlobalSign::UrlVerification::Request.new(
product_code: 'DV_LOW_URL',
order_kind: 'renewal',
validity_period_months: 6,
csr: csr,
renewal_target_order_id: 'xxxx123456789',
contract_info: contract,
)
```
### DNS Verification
Verification flow is the same as URL Verification. Request class use the following:
```ruby
client = GlobalSign::Client.new
request = GlobalSign::DnsVerification::Request.new(
product_code: 'DV_LOW_DNS',
order_kind: 'new',
validity_period_months: 6,
csr: csr,
contract_info: contract,
)
response = client.process(request)
if response.success?
puts "Successfully DNS Verification"
puts response.params # => { dns_txt: "xxxxx", verification_fqdn_list: ['example.com', 'www.example.com'], ... }
else
raise StandardError, "#{response.error_code}: #{response.error_message}"
end
```
### URL Verification for Issue
```ruby
client = GlobalSign::Client.new
# You can use ApproverURL value such as:
# - http://example.com
# - https://example.com
# - http://www.example.com
# - https://www.example.com
request = GlobalSign::UrlVerificationForIssue::Request.new(
order_id: 'xxxx123456789',
approver_url: 'http://example.com',
)
response = client.process(request)
if response.success?
puts "Successfully URL Verification for Issue"
puts response.params # => { fulfillment: { ca_certificates: [{ ca_cert: "xxxxx" }, ...]}, ... }
else
raise StandardError, "#{response.error_code}: #{response.error_message}"
end
```
### DNS Verification for Issue
```ruby
client = GlobalSign::Client.new
# You can use ApproverFQDN value such as:
# - www.example.com
# - example.com
request = GlobalSign::UrlVerificationForIssue::Request.new(
order_id: 'xxxx123456789',
approver_fqdn: 'www.example.com',
)
response = client.process(request)
if response.success?
puts "Successfully DNS Verification for Issue"
puts response.params # => { fulfillment: { ca_certificates: [{ ca_cert: "xxxxx" }, ...]}, ... }
else
raise StandardError, "#{response.error_code}: #{response.error_message}"
end
```
### Get Order by OrderID
```ruby
request = GlobalSign::OrderGetterByOrderId::Request.new(
order_id: 'xxxx123456789'
)
response = client.process(request)
puts response.params # => { order_id: "xxxx123456789", order_status: "2", ... }
# You can get order_status explanation
puts response.order_status_text # => "phishing_checking"
```
You can specify request options.
```ruby
# certificate_info option
request = GlobalSign::OrderGetterByOrderId::Request.new(
order_id: 'xxxx123456789',
options: { certificate_info: true }
)
response = client.process(request)
puts response.params[:certificate_info] # => { certificate_status: '4', start_date: '2016-10-06T14:53:23.000+09:00', ... }
# fulfillment option
request = GlobalSign::OrderGetterByOrderId::Request.new(
order_id: 'xxxx123456789',
options: { fulfillment: true }
)
response = client.process(request)
puts response.params[:fulfillment] # => { ca_certificates: [{ ca_cert: "xxxxx" }, ...]}
```
### Decode CSR
```ruby
request = GlobalSign::CsrDecoder::Request.new(
product_type: 'DV_LOW',
csr: csr
)
response = client.process(request)
puts response.params # => { common_name: "www.example.com", ... }
```
### Client options
`GlobalSign::Client` allows `options` argument in order to specify its behavior.
For now, it supports `timeout` which specifies number of seconds to wait for request.
```ruby
client = GlobalSign::Client.new(options: { timeout: 120 })
```
## Contributing
1. Create your feature branch (git checkout -b my-new-feature)
2. Commit your changes (git commit -am 'Add some feature')
3. Push to the branch (git push origin my-new-feature)
4. Create a new Pull Request
## License
The MIT License (MIT)
Copyright (c) 2016- GMO Pepabo, Inc.