global_sign 1.0.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 84af7ff572f96ab29ffd4afe338dc508162d7f52
-  data.tar.gz: c4dfa41c3d53f261631d92827e76bc0c74fb514f
+SHA256:
+  metadata.gz: adff6a919745a77e1100fe13c7e40a5f2b39bd754fc12748b3146c4a6bb44dc9
+  data.tar.gz: ab6a1be53ba7da8d9f0f40004b908d3e25731a32d5b2dff5ac2f89fd91b511bb
 SHA512:
-  metadata.gz: 13a1d366b9c0f6ebac2db39fbb4c440eb72c35c8d28de7fb6c7ed98e0d7d0d54082f2eb04d0604a477d647622c40e63b1b6eb6265fc7bad86cc2272f1a92d604
-  data.tar.gz: 2295e6dab6536d59d6fba5200398364ded71eb10d26c7d2c2a875ec6e19b73e5e1d8d75faae81fe07f0be54e366c928d138ffd3b0626f922c925eed7a2e19628
+  metadata.gz: ba107322e6fdc9b33b031dc3b1c1613e251ce95536901bf94454f8a476da5391e8c13457b7f5cdf945015ef957597d6882cba056085c4e593119ea09add1667a
+  data.tar.gz: 1109ff5ea85ee7af0986e24c522071df1397afd5697818454a91fa537af84ae06edc1d8d37c557b8ea0e91defc76e858dc19e95941320fe8bdb2f1ff9f3f1bd6

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+## 2.3.0
+- Support GlobalSign API: EVOrder
+
+## 2.2.0
+
+- Added `options` optional keyword argument to `GlobalSign::Client`
+  - It supports `timeout` which specifies number of seconds to wait for request
+
+## 2.1.1
+- Fixed bug: `GlobalSign::OrderGetterByOrderId::Request` NoMethodError: undefined method `text` for nil:NilClass
+
+## 2.1.0
+
+- Support GlobalSign API: DecodeCSR
+- Support GlobalSign API: DVDNSOrder & DVDNSVerificationForIssue
+- Added `options` optional keyword argument to `GlobalSign::OrderGetterByOrderId::Request` for getting certificate info and fulfillment
+
+## 2.0.0
+
+- Added `product_code` required keyword argument to `GlobalSign::UrlVerification::Request` for selecting SSL certificate type
+
+## 1.0.0
+
+- Support GlobalSign API: URLVerification & URLVerificationForIssue
+- Support GlobalSign API: GetOrderByOrderID

data/README.md

@@ -1,6 +1,7 @@
 # GlobalSign
 
-[![wercker status](https://app.wercker.com/status/8cf8771f0da8bc4f1ea0adc8eb65b295/s/master "wercker status")](https://app.wercker.com/project/byKey/8cf8771f0da8bc4f1ea0adc8eb65b295)
+[![Gem Version](https://badge.fury.io/rb/global_sign.svg)](https://badge.fury.io/rb/global_sign)
+![CI](https://github.com/pepabo/global_sign/workflows/CI/badge.svg?branch=master)
 
 A Ruby interface to the [GlobalSign](https://www.globalsign.com/) API.
 
@@ -62,6 +63,7 @@ contract = GlobalSign::Contract.new(
 )
 
 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,
@@ -90,6 +92,7 @@ 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,
@@ -101,6 +104,7 @@ 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,
@@ -109,6 +113,31 @@ request = GlobalSign::UrlVerification::Request.new(
 )
 ```
 
+### 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
@@ -135,10 +164,36 @@ else
 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')
+request = GlobalSign::OrderGetterByOrderId::Request.new(
+  order_id: 'xxxx123456789'
+)
 response = client.process(request)
 
 puts response.params # => { order_id: "xxxx123456789", order_status: "2", ... }
@@ -147,6 +202,49 @@ puts response.params # => { order_id: "xxxx123456789", order_status: "2", ... }
 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)

data/global_sign.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(.github|test|spec|features)/})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'faraday'
   spec.add_runtime_dependency 'nokogiri'
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'vcr'

data/lib/global_sign.rb

@@ -3,6 +3,15 @@ require 'active_support/core_ext/hash/conversions'
 require 'global_sign/version'
 require 'global_sign/client'
 require 'global_sign/contract'
+require 'global_sign/organization_address'
+require 'global_sign/organization_info'
+require 'global_sign/organization_info/credit_agency'
+require 'global_sign/organization_info_ev'
+require 'global_sign/organization_info_ev/business_category_code'
+require 'global_sign/requestor_info'
+require 'global_sign/approver_info'
+require 'global_sign/authorized_signer_info'
+require 'global_sign/jurisdiction_info'
 require 'global_sign/request_xml_builder'
 require 'global_sign/request'
 require 'global_sign/response'
@@ -11,6 +20,13 @@ require 'global_sign/order_status'
 require 'global_sign/url_verification'
 require 'global_sign/url_verification_for_issue'
 require 'global_sign/order_getter_by_order_id'
+require 'global_sign/csr_decoder'
+require 'global_sign/dns_verification'
+require 'global_sign/dns_verification_for_issue'
+require 'global_sign/dv_approver_list'
+require 'global_sign/dv_order'
+require 'global_sign/ov_order'
+require 'global_sign/ev_order'
 
 module GlobalSign
   class << self

data/lib/global_sign/approver_info.rb

@@ -0,0 +1,15 @@
+module GlobalSign
+  class ApproverInfo
+    attr_accessor :first_name, :last_name, :function, :organization_name, :organization_unit, :phone_number, :email
+
+    def initialize(first_name:, last_name:, function: nil, organization_name:, organization_unit: nil, phone_number:, email:)
+      @first_name        = first_name
+      @last_name         = last_name
+      @function          = function
+      @organization_name = organization_name
+      @organization_unit = organization_unit
+      @phone_number      = phone_number
+      @email             = email
+    end
+  end
+end

data/lib/global_sign/authorized_signer_info.rb

@@ -0,0 +1,14 @@
+module GlobalSign
+  class AuthorizedSignerInfo
+    attr_accessor :first_name, :last_name, :function, :organization_name, :phone_number, :email
+
+    def initialize(first_name:, last_name:, function: nil, organization_name:, phone_number:, email:)
+      @first_name        = first_name
+      @last_name         = last_name
+      @function          = function
+      @organization_name = organization_name
+      @phone_number      = phone_number
+      @email             = email
+    end
+  end
+end

data/lib/global_sign/client.rb

@@ -2,12 +2,13 @@ require 'faraday'
 
 module GlobalSign
   class Client
-    def initialize
+    def initialize(options: {})
       @configuration = GlobalSign.configuration
 
       @connection = Faraday::Connection.new(url: @configuration.endpoint) do |conn|
         conn.request :url_encoded
         conn.adapter Faraday.default_adapter
+        conn.options[:timeout] = options[:timeout] if options[:timeout].present?
       end
     end
 
@@ -25,12 +26,26 @@ module GlobalSign
 
     def find_response_class_for(request)
       case request
+      when GlobalSign::CsrDecoder::Request
+        GlobalSign::CsrDecoder::Response
+      when GlobalSign::DnsVerification::Request
+        GlobalSign::DnsVerification::Response
+      when GlobalSign::DnsVerificationForIssue::Request
+        GlobalSign::DnsVerificationForIssue::Response
       when GlobalSign::UrlVerification::Request
         GlobalSign::UrlVerification::Response
       when GlobalSign::UrlVerificationForIssue::Request
         GlobalSign::UrlVerificationForIssue::Response
       when GlobalSign::OrderGetterByOrderId::Request
         GlobalSign::OrderGetterByOrderId::Response
+      when GlobalSign::DVApproverList::Request
+        GlobalSign::DVApproverList::Response
+      when GlobalSign::DVOrder::Request
+        GlobalSign::DVOrder::Response
+      when GlobalSign::OVOrder::Request
+        GlobalSign::OVOrder::Response
+      when GlobalSign::EVOrder::Request
+        GlobalSign::EVOrder::Response
       else
         raise ArgumentError, 'invalid request argument'
       end

data/lib/global_sign/csr_decoder.rb

@@ -0,0 +1,2 @@
+require 'global_sign/csr_decoder/request'
+require 'global_sign/csr_decoder/response'

data/lib/global_sign/csr_decoder/request.rb

@@ -0,0 +1,29 @@
+module GlobalSign
+  module CsrDecoder
+    class Request < GlobalSign::Request
+      def initialize(csr:, product_type:)
+        @csr          = csr
+        @product_type = product_type
+      end
+
+      def path
+        'GASService'
+      end
+
+      def action
+        'DecodeCSR'
+      end
+
+      def request_header
+        :QueryRequestHeader
+      end
+
+      def params
+        {
+          CSR:         @csr,
+          ProductType: @product_type
+        }
+      end
+    end
+  end
+end

data/lib/global_sign/csr_decoder/response.rb

@@ -0,0 +1,36 @@
+module GlobalSign
+  module CsrDecoder
+    class Response < GlobalSign::Response
+      module XPath
+        CSRData            = '//Response/CSRData'
+        CertificatePreview = '//Response/CertificatePreview'
+      end
+
+      def response_header
+        :QueryResponseHeader
+      end
+
+      def params
+        @params ||= {
+          csr_data:            detail(@xml.xpath(XPath::CSRData)),
+          certificate_preview: detail(@xml.xpath(XPath::CertificatePreview))
+        }
+      end
+
+      private
+
+      def detail(data)
+        {
+          common_name:       data.at('CommonName').try(:text)   || '',
+          organization:      data.at('Organization').try(:text) || '',
+          organization_unit: data.at('Organization').try(:text) || '',
+          locality:          data.at('Locality').try(:text)     || '',
+          state:             data.at('State').try(:text)        || '',
+          country:           data.at('Country').try(:text)      || '',
+          email_address:     data.at('EmailAddress').try(:text) || '',
+          key_length:        data.at('KeyLength').try(:text)    || ''
+        }
+      end
+    end
+  end
+end

data/lib/global_sign/dns_verification.rb

@@ -0,0 +1,2 @@
+require 'global_sign/dns_verification/request'
+require 'global_sign/dns_verification/response'

data/lib/global_sign/dns_verification/request.rb

@@ -0,0 +1,55 @@
+module GlobalSign
+  module DnsVerification
+    class Request < GlobalSign::UrlVerification::Request
+      def initialize(product_code:, order_kind:, validity_period_months:, csr:, renewal_target_order_id: nil, contract_info: nil)
+        @product_code            = product_code
+        @order_kind              = order_kind
+        @validity_period_months  = validity_period_months
+        @csr                     = csr
+        @renewal_target_order_id = renewal_target_order_id
+        @contract_info           = contract_info || GlobalSign.contract
+      end
+
+      def path
+        'ServerSSLService'
+      end
+
+      def action
+        'DVDNSOrder'
+      end
+
+      def request_header
+        :OrderRequestHeader
+      end
+
+      def params
+        _params = {
+          OrderRequestParameter: {
+            ProductCode: @product_code,
+            OrderKind:   @order_kind,
+            Licenses:    1,
+            ValidityPeriod: {
+              Months: @validity_period_months
+            },
+            CSR: @csr,
+          },
+          ContactInfo: {
+            FirstName: @contract_info.first_name,
+            LastName:  @contract_info.last_name,
+            Phone:     @contract_info.phone_number,
+            Email:     @contract_info.email
+          }
+        }
+
+        # require `RenewalTargetOrderID` to request a renewal certificate
+        if @order_kind == 'renewal'
+          _params[:OrderRequestParameter].merge!(
+            { RenewalTargetOrderID: @renewal_target_order_id }
+          )
+        end
+
+        _params
+      end
+    end
+  end
+end