global_sign 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5a54622924310a43ab46e3a6973962ad4bf45be
-  data.tar.gz: f887d279c8a4f186bcdb521b750e88bc608a0b00
+  metadata.gz: 916c05af61f1d1c2044bf3470e77bd4a47e120fe
+  data.tar.gz: 3d6bae04c691a34ab72f7d69fb658e4e8d018fd2
 SHA512:
-  metadata.gz: 33bb4c0ff984aaafd1c157701d7297fec8291a3f3187d2c99d5b24f5aebed49b28ea5fd0c9c3fee7c057c1f4b32e7a29b801096e95e5f878375b394d681e0e37
-  data.tar.gz: 42d3222a900e70362a42a2d22995343ac37c072d648050ec674d67fcee38ba96e229e9c8b72321dcf6fa0d6c618a023780b167464e613527678a08a61603ee11
+  metadata.gz: 11f5cdc7182ab5affc64af5d05327b56551bb2152742d783230506267be3e5405271331bbc68dabf577dc6594347a6ba9ca0bcecd8c4fc8fbeb9ede0395ee0db
+  data.tar.gz: 52d4a09e9fb441cd04974b2b6687abb35306581743cea59bc01ba3817ae7d7d6a35cf77378325fc9d85f3d8e021207e5f3f16a93e9cb75d75e0b8bdb2c1568ce

data/CHANGELOG.md

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

data/README.md

@@ -113,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
@@ -139,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", ... }
@@ -151,6 +202,40 @@ 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", ... }
+```
+
 ## Contributing
 
 1. Create your feature branch (git checkout -b my-new-feature)

data/lib/global_sign/client.rb

@@ -25,6 +25,12 @@ 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

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/csr_decoder.rb

@@ -0,0 +1,2 @@
+require 'global_sign/csr_decoder/request'
+require 'global_sign/csr_decoder/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

data/lib/global_sign/dns_verification/response.rb

@@ -0,0 +1,29 @@
+module GlobalSign
+  module DnsVerification
+    class Response < GlobalSign::Response
+      module XPath
+        ORDER_ID               = '//Response/OrderID'
+        DNS_TXT                = '//Response/DNSTXT'
+        VERIFICATION_FQDN_LIST = '//Response/VerificationFQDNList'
+      end
+
+      def response_header
+        :OrderResponseHeader
+      end
+
+      def params
+        @params ||= {
+          order_id:               @xml.xpath(XPath::ORDER_ID).text,
+          dns_txt:                @xml.xpath(XPath::DNS_TXT).text,
+          verification_fqdn_list: verification_fqdn_list,
+        }
+      end
+
+      private
+
+      def verification_fqdn_list
+        @xml.xpath(XPath::VERIFICATION_FQDN_LIST).children.map(&: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_for_issue/request.rb

@@ -0,0 +1,29 @@
+module GlobalSign
+  module DnsVerificationForIssue
+    class Request < GlobalSign::Request
+      def initialize(order_id:, approver_fqdn:)
+        @order_id      = order_id
+        @approver_fqdn = approver_fqdn
+      end
+
+      def path
+        'ServerSSLService'
+      end
+
+      def action
+        'DVDNSVerificationForIssue'
+      end
+
+      def request_header
+        :OrderRequestHeader
+      end
+
+      def params
+        {
+          OrderID:      @order_id,
+          ApproverFQDN: @approver_fqdn,
+        }
+      end
+    end
+  end
+end

data/lib/global_sign/dns_verification_for_issue/response.rb

@@ -0,0 +1,53 @@
+module GlobalSign
+  module DnsVerificationForIssue
+    class Response < GlobalSign::Response
+      module XPath
+        Certificate_Info   = '//Response/URLVerificationForIssue/CertificateInfo'
+        CA_Certificates    = '//Response/URLVerificationForIssue/Fulfillment/CACertificates'
+        Server_Certificate = '//Response/URLVerificationForIssue/Fulfillment/ServerCertificate'
+      end
+
+      def response_header
+        :OrderResponseHeader
+      end
+
+      def params
+        @params ||= {
+          certificate_info: {
+            certificate_status: certificate_info.at('CertificateStatus').text,
+            start_date:         certificate_info.at('StartDate').text,
+            end_date:           certificate_info.at('EndDate').text,
+            common_name:        certificate_info.at('CommonName').text,
+            subject_name:       certificate_info.at('SubjectName').text,
+          },
+          fulfillment: {
+            ca_certificates: ca_certificates_list,
+            server_certificate: {
+              x509_cert:  server_certificate.at('X509Cert').text,
+              pkcs7_cert: server_certificate.at('PKCS7Cert').text,
+            }
+          }
+        }
+      end
+
+      private
+
+      def certificate_info
+        @xml.xpath(XPath::Certificate_Info)
+      end
+
+      def ca_certificates_list
+        @xml.xpath(XPath::CA_Certificates).children.map do |c|
+          {
+            ca_cert_type: c.at('CACertType').text,
+            ca_cert:      c.at('CACert').text,
+          }
+        end
+      end
+
+      def server_certificate
+        @xml.xpath(XPath::Server_Certificate)
+      end
+    end
+  end
+end

data/lib/global_sign/dns_verification_for_issue.rb

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

data/lib/global_sign/order_getter_by_order_id/request.rb

@@ -1,8 +1,9 @@
 module GlobalSign
   module OrderGetterByOrderId
     class Request < GlobalSign::Request
-      def initialize(order_id:)
+      def initialize(order_id:, options: {})
         @order_id = order_id
+        @options  = options
       end
 
       def path
@@ -18,7 +19,15 @@ module GlobalSign
       end
 
       def params
-        { OrderID: @order_id }
+        _params = { OrderID: @order_id }
+
+        # options
+        option_params = {}
+        option_params[:ReturnCertificateInfo] = true if @options[:certificate_info]
+        option_params[:ReturnFulfillment]     = true if @options[:fulfillment]
+        _params[:OrderQueryOption] = option_params   if option_params.present?
+
+        _params
       end
     end
   end

data/lib/global_sign/order_getter_by_order_id/response.rb

@@ -5,14 +5,44 @@ module GlobalSign
         ORDER_ID            = '//Response/OrderID'
         ORDER_STATUS        = '//Response/OrderDetail/OrderInfo/OrderStatus'
         MODIFICATION_EVENTS = '//Response/OrderDetail/ModificationEvents'
+
+        # options
+        CERTIFICATE_INFO    = '//Response/OrderDetail/CertificateInfo'
+        FULFILLMENT         = '//Response/OrderDetail/Fulfillment'
+        CA_CERTIFICATES     = '//Response/OrderDetail/Fulfillment/CACertificates'
+        SERVER_CERTIFICATE  = '//Response/OrderDetail/Fulfillment/ServerCertificate'
+      end
+
+      def response_header
+        :OrderResponseHeader
       end
 
       def params
-        @params ||= {
+        return @params if @params
+        _params = {
           order_id:            @xml.xpath(XPath::ORDER_ID).text,
           order_status:        @xml.xpath(XPath::ORDER_STATUS).text,
           modification_events: modification_events_list
         }
+
+        # options
+        _params[:certificate_info] = {
+          certificate_status: certificate_info.at('CertificateStatus').text,
+          start_date:         certificate_info.at('StartDate').text,
+          end_date:           certificate_info.at('EndDate').text,
+          common_name:        certificate_info.at('CommonName').text,
+          subject_name:       certificate_info.at('SubjectName').text,
+        } if certificate_info.text.present?
+
+        _params[:fulfillment] = {
+            ca_certificates: ca_certificates_list,
+            server_certificate: {
+              x509_cert:  server_certificate.at('X509Cert').text,
+              pkcs7_cert: server_certificate.at('PKCS7Cert').text,
+            }
+        } if fulfillment.text.present?
+
+        @params = _params
       end
 
       def order_status_text
@@ -29,6 +59,27 @@ module GlobalSign
           }
         end
       end
+
+      def certificate_info
+        @xml.xpath(XPath::CERTIFICATE_INFO)
+      end
+
+      def fulfillment
+        @xml.xpath(XPath::FULFILLMENT)
+      end
+
+      def ca_certificates_list
+        @xml.xpath(XPath::CA_CERTIFICATES).children.map do |c|
+          {
+            ca_cert_type: c.at('CACertType').text,
+            ca_cert:      c.at('CACert').text,
+          }
+        end
+      end
+
+      def server_certificate
+        @xml.xpath(XPath::SERVER_CERTIFICATE)
+      end
     end
   end
 end

data/lib/global_sign/response.rb

@@ -5,21 +5,24 @@ module GlobalSign
     SUCCESS_CODE = '0'.freeze
     WARNING_CODE = '1'.freeze
 
-    module XPath
-      RESULT = '//Response/OrderResponseHeader/SuccessCode'
-      ERRORS = '//Response/OrderResponseHeader/Errors'
-    end
-
     def initialize(body)
       @xml = Nokogiri::XML(body)
     end
 
+    def xpath_result
+      "//Response/#{response_header}/SuccessCode"
+    end
+
+    def xpath_errors
+      "//Response/#{response_header}/Errors"
+    end
+
     def success?
-      @xml.xpath(XPath::RESULT).text == SUCCESS_CODE
+      @xml.xpath(xpath_result).text == SUCCESS_CODE
     end
 
     def warning?
-      @xml.xpath(XPath::RESULT).text == WARNING_CODE
+      @xml.xpath(xpath_result).text == WARNING_CODE
     end
 
     def error?
@@ -41,7 +44,7 @@ module GlobalSign
     private
 
     def errors
-      @xml.xpath(XPath::ERRORS)
+      @xml.xpath(xpath_errors)
     end
   end
 end

data/lib/global_sign/url_verification/response.rb

@@ -7,6 +7,10 @@ module GlobalSign
         VERIFICATION_URL_LIST = '//Response/VerificationURLList'
       end
 
+      def response_header
+        :OrderResponseHeader
+      end
+
       def params
         @params ||= {
           order_id:              @xml.xpath(XPath::ORDER_ID).text,

data/lib/global_sign/url_verification_for_issue/response.rb

@@ -7,6 +7,10 @@ module GlobalSign
         Server_Certificate = '//Response/URLVerificationForIssue/Fulfillment/ServerCertificate'
       end
 
+      def response_header
+        :OrderResponseHeader
+      end
+
       def params
         @params ||= {
           certificate_info: {

data/lib/global_sign/version.rb

@@ -1,3 +1,3 @@
 module GlobalSign
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/global_sign.rb

@@ -11,6 +11,9 @@ 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'
 
 module GlobalSign
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: global_sign
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - ku00
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2016-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -185,6 +185,15 @@ files:
 - lib/global_sign.rb
 - lib/global_sign/client.rb
 - lib/global_sign/contract.rb
+- lib/global_sign/csr_decoder.rb
+- lib/global_sign/csr_decoder/request.rb
+- lib/global_sign/csr_decoder/response.rb
+- lib/global_sign/dns_verification.rb
+- lib/global_sign/dns_verification/request.rb
+- lib/global_sign/dns_verification/response.rb
+- lib/global_sign/dns_verification_for_issue.rb
+- lib/global_sign/dns_verification_for_issue/request.rb
+- lib/global_sign/dns_verification_for_issue/response.rb
 - lib/global_sign/order_getter_by_order_id.rb
 - lib/global_sign/order_getter_by_order_id/request.rb
 - lib/global_sign/order_getter_by_order_id/response.rb