geocerts 0.0.11

data/lib/geo_certs/api_object.rb

@@ -0,0 +1,111 @@
+module GeoCerts
+  
+  class ApiObject # :nodoc:
+    
+    def initialize(attributes = {}, &block)
+      update_attributes(attributes)
+      yield(self) if block_given?
+    end
+    
+    def errors
+      @errors ||= []
+    end
+    
+    def warnings
+      @warnings ||= []
+    end
+    
+    def warnings=(input) # :nodoc:
+      @warnings = case input
+        when Hash
+          case input[:warning]
+          when Array
+            input[:warning].collect { |warning| GeoCerts::Warning.new(warning) }
+          end
+        when Array
+          input if input.all? { |item| item.kind_of?(GeoCerts::Warning) }
+        end
+    end
+    
+    def errors=(input) # :nodoc:
+      @errors = case input
+        when Hash
+          case input[:error]
+          when Array
+            input[:error].collect { |error| GeoCerts::Error.new(error) }
+          end
+        when Array
+          input if input.all? { |item| item.kind_of?(GeoCerts::Error) }
+        end
+    end
+    
+    
+    protected
+    
+    
+    def self.call_api # :nodoc:
+      yield if block_given?
+    rescue RestClient::ResourceNotFound
+      raise GeoCerts::ResourceNotFound.new($!)
+    rescue RestClient::Unauthorized
+      raise GeoCerts::Unauthorized.new($!)
+    rescue RestClient::RequestFailed
+      case $!.http_code
+      when 422
+        raise GeoCerts::UnprocessableEntity.new($!)
+      when 400
+        raise GeoCerts::BadRequest.new($!)
+      else
+        raise GeoCerts::RequestFailed.new($!)
+      end
+    rescue RestClient::RequestTimeout
+      raise GeoCerts::RequestTimeout.new($!.message)
+    rescue *GeoCerts::HTTP_ERRORS
+      raise GeoCerts::ConnectionError.new($!.message)
+    # rescue
+    #   raise GeoCerts::Exception.from($!)
+    end
+    
+    def self.force_boolean(*attributes) # :nodoc:
+      attributes.each do |attribute|
+        define_method("#{attribute}=") do |input|       # def trial=(input)
+          instance_variable_set("@#{attribute}",        #   @trial =
+                                !!(input =~ /true/i))   #     !!(input =~ /true/i)
+        end                                             # end
+        
+        define_method("#{attribute}?") do               # def trial?
+          send(attribute.to_sym)                        #   send(:trial)
+        end                                             # end
+      end
+    end
+    
+    def self.build_collection(response) # :nodoc:
+      raise(ArgumentError, "Missing block") unless block_given?
+      collection = Collection.new
+      collection.start_at = response[:start_at]
+      collection.end_at   = response[:end_at]
+      yield(response).each { |order| collection << new(order) }
+      collection
+    end
+    
+    def self.prep_date_ranges!(options)
+      options[:start_at]  = options[:start_at].xmlschema  if options.has_key?(:start_at)  && options[:start_at].respond_to?(:xmlschema)
+      options[:end_at]    = options[:end_at].xmlschema    if options.has_key?(:end_at)    && options[:start_at].respond_to?(:xmlschema)
+    end
+    
+    
+    def store_exception_errors_and_warnings(exception)
+      self.warnings = exception.warnings  if exception.respond_to?(:warnings)
+      self.errors   = exception.errors    if exception.respond_to?(:errors)
+    end
+    
+    def update_attributes(attributes) # :nodoc:
+      attributes.each_pair do |name, value|
+        send("#{name}=", value) if respond_to?(name)
+      end
+      self
+    end
+    
+  end
+  
+end

data/lib/geo_certs/certificate.rb

@@ -0,0 +1,88 @@
+require 'geo_certs/api_object'
+
+module GeoCerts
+  
+  ##
+  # Contains the information for a secure server certificate.  Generally, these objects would
+  # be created and populated via GeoCerts::Order.certificate, unless you are looking for a 
+  # listing of certificates in your account (see GeoCerts::Certificate.all).
+  # 
+  class Certificate < ApiObject
+    
+    attr_accessor :order_id,
+                  :geotrust_order_id,
+                  :status,
+                  :certificate,
+                  :ca_root,
+                  :common_name,
+                  :serial_number,
+                  :start_at,
+                  :end_at,
+                  :city,
+                  :state,
+                  :country,
+                  :organization,
+                  :organizational_unit,
+                  :approver_email,
+                  :reissue_email,
+                  :trial,
+                  :url
+    
+    force_boolean :trial
+    
+    ##
+    # Returns all certificates for a given window of time.  The server defaults to a 1 month
+    # window.
+    # 
+    # === Options
+    # 
+    # :start_at:: The starting DateTime for the date range
+    # :end_at:: The ending DateTime for the date range
+    # 
+    def self.all(options = {})
+      prep_date_ranges!(options)
+      response = call_api { GeoCerts.api.certificates(options) }
+      build_collection(response) { |response| response[:certificates][:certificate] }
+    end
+    
+    ##
+    # Returns the certificate for the given GeoCerts::Order
+    # 
+    # === Exceptions
+    # 
+    # This method will raise exceptions if the given +order_id+ cannot be found in the GeoCerts
+    # system.
+    # 
+    def self.find(order_id)
+      order_id = order_id.id if order_id.kind_of?(GeoCerts::Order)
+      new(call_api { GeoCerts.api.find_certificate(:order_id => order_id)[:certificate] })
+    end
+    
+    ##
+    # Returns the certificate for the given GeoCerts::Order by ID.
+    # 
+    # If the +order_id+ cannot be found in the GeoCerts system, this method will return +nil+.
+    # 
+    def self.find_by_order_id(order_id)
+      find(order_id)
+    rescue GeoCerts::AllowableExceptionWithResponse
+      nil
+    end
+    
+    
+    ##
+    # Reissues the certificate given a proper CSR.
+    # 
+    def reissue!(csr)
+      csr = csr.body if csr.kind_of?(GeoCerts::CSR)
+      update_attributes(self.class.call_api {
+        GeoCerts.api.reissue_certificate({
+          :order_id => self.order_id,
+          :csr_body => GeoCerts.escape(csr || '')
+        })
+      })
+    end
+    
+  end
+  
+end

data/lib/geo_certs/collection.rb

@@ -0,0 +1,12 @@
+module GeoCerts
+  
+  ##
+  # A GeoCerts::Collection is used whenever a collection of GeoCerts objects is returned from
+  # this library.  It adds the additional attributes of +end_at+ and +start_at+, representing
+  # the DateTime range from which the collection contains data.
+  # 
+  class Collection < Array
+    attr_accessor :end_at, :start_at
+  end
+  
+end

data/lib/geo_certs/csr.rb

@@ -0,0 +1,31 @@
+require 'cgi'
+
+module GeoCerts
+  
+  ##
+  # Wraps information required by or received from GeoCerts about a 
+  # Certificate Signing Request (CSR).
+  # 
+  class CSR
+    
+    attr_accessor :body,
+                  :common_name,
+                  :city,
+                  :state,
+                  :country,
+                  :organization,
+                  :organizational_unit
+    
+    def initialize(attributes = {})
+      attributes.each_pair do |name, value|
+        send("#{name}=", value) if respond_to?(name)
+      end
+    end
+    
+    def to_geocerts_hash
+      { :csr_body => GeoCerts.escape(self.body) }
+    end
+    
+  end
+  
+end

data/lib/geo_certs/email.rb

@@ -0,0 +1,8 @@
+module GeoCerts
+  
+  ##
+  # Wraps the information received for an email address from GeoCerts.
+  # 
+  Email = Struct.new(:address)
+  
+end

data/lib/geo_certs/endpoints/agreements.rb

@@ -0,0 +1,23 @@
+module GeoCerts
+  module Endpoints # :nodoc:
+    
+    module Agreements # :nodoc:
+      
+      def self.included(base)
+        base.class_eval do
+          endpoint GeoCerts::API::ENDPOINT do
+            
+            action :agreement, :url => '/products/:product_id/agreement.xml' do
+              parser Parsers::OrderParser do
+                element :agreement
+              end
+            end
+            
+          end
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/geo_certs/endpoints/certificates.rb

@@ -0,0 +1,73 @@
+module GeoCerts
+  module Endpoints # :nodoc:
+    
+    module Certificates # :nodoc:
+      
+      ELEMENTS = <<-CERTIFICATE
+      element 'order-id',             :as => :order_id,           :type => Integer
+      element 'geotrust-order-id',    :as => :geotrust_order_id
+      element :status
+      element :certificate
+      element 'ca-root',              :as => :ca_root
+      element 'common-name',          :as => :common_name
+      element 'serial-number',        :as => :serial_number
+      element 'start-date',           :as => :start_at,           :type => DateTime
+      element 'end-date',             :as => :end_at,             :type => DateTime
+      element :locality,              :as => :city
+      element :state
+      element :organization
+      element 'organizational-unit',  :as => :organizational_unit
+      element :country
+      element 'approver-email',       :as => :approver_email
+      element 'reissue-email',        :as => :reissue_email
+      element :trial
+      element :url
+      element 'dns-names',            :as => :sans
+CERTIFICATE
+      
+      def self.included(base)
+        base.class_eval do
+          endpoint GeoCerts::API::ENDPOINT do
+            
+            action :certificates, :url => '/certificates.xml' do
+              parameter :start_at
+              parameter :end_at
+              
+              parser Parsers::OrderParser do
+                attribute 'start_at',             :as => :start_at,           :type => DateTime
+                attribute 'end_at',               :as => :end_at,             :type => DateTime
+                
+                element :certificates do
+                  elements :certificate, :xpath => 'certificates/certificate' do
+                    eval(ELEMENTS)
+                  end
+                end
+              end
+            end
+            
+            action :find_certificate, :url => '/orders/:order_id/certificate.xml' do
+              parser Parsers::OrderParser do
+                element :certificate,     :xpath => '/certificate' do
+                  eval(ELEMENTS)
+                  element :certificate,   :xpath => '/certificate/certificate/text()'
+                end
+              end
+            end
+            
+            action :reissue_certificate, :url => '/orders/:order_id/certificate/reissue.xml', :method => :post do
+              parameter 'order[csr][body]',     :as => :csr_body
+              parser Parsers::OrderParser do
+                element :certificate,     :xpath => '/certificate' do
+                  eval(ELEMENTS)
+                end
+              end
+            end
+            
+          end
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/geo_certs/endpoints/events.rb

@@ -0,0 +1,56 @@
+module GeoCerts
+  module Endpoints # :nodoc:
+    
+    module Events # :nodoc:
+      
+      def self.included(base)
+        base.class_eval do
+          endpoint GeoCerts::API::ENDPOINT do
+            
+            action :events, :url => '/events.xml' do
+              parameter :start_at
+              parameter :end_at
+              
+              parser Parsers::OrderParser do
+                element :events do
+                  attribute 'start_at',             :as => :start_at,           :type => DateTime
+                  attribute 'end_at',               :as => :end_at,             :type => DateTime
+                  
+                  elements :event do
+                    element 'event-id',             :as => :id,                 :type => Integer
+                    element 'order-id',             :as => :order_id,           :type => Integer
+                    element :name
+                    element 'created-at',           :as => :created_at,         :type => DateTime
+                  end
+                end
+              end
+            end
+            
+            action :order_events, :url => '/orders/:order_id/events.xml' do
+              parameter :start_at
+              parameter :end_at
+              
+              parser Parsers::OrderParser do
+                element :events do
+                  attribute 'start_at',             :as => :start_at,           :type => DateTime
+                  attribute 'end_at',               :as => :end_at,             :type => DateTime
+                  
+                  elements :event do
+                    element 'event-id',             :as => :id,                 :type => Integer
+                    element 'order-id',             :as => :order_id,           :type => Integer
+                    element :name
+                    element 'created-at',           :as => :created_at,         :type => DateTime
+                  end
+                end
+              end
+            end
+            
+            
+          end
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/geo_certs/endpoints/orders.rb

@@ -0,0 +1,181 @@
+require 'geo_certs/parsers/order_parser'
+
+module GeoCerts
+  module Endpoints # :nodoc:
+
+    module Orders # :nodoc:
+
+      ELEMENTS = <<-ORDER
+      element :id,                                              :type => Integer
+      element 'geotrust-order-id',  :as => :geotrust_order_id
+      element :domain
+      element "status-major",       :as => :status_major
+      element "status-minor",       :as => :status_minor
+      element :years,                                           :type => Integer
+      element :licenses,                                        :type => Integer
+      element 'created-at',         :as => :created_at,         :type => DateTime
+      element 'completed-at',       :as => :completed_at,       :type => DateTime
+      element :trial
+      element :renewal
+      element :sans
+      element :state
+      element 'total-price',        :as => :total_price,        :type => Float
+      element 'pending-audit',      :as => :pending_audit
+
+      element :product do
+        element :sku
+      end
+
+      element :warnings do
+        elements :warning do
+          element :code, :type => Float
+          element :message
+        end
+      end
+ORDER
+
+      def self.included(base)
+        base.class_eval do
+          endpoint GeoCerts::API::ENDPOINT do
+
+            action :orders, :url => '/orders.xml' do
+              parameter :start_at
+              parameter :end_at
+
+              parser Parsers::OrderParser do
+                attribute 'start_at',             :as => :start_at,           :type => DateTime
+                attribute 'end_at',               :as => :end_at,             :type => DateTime
+
+                element :orders do
+                  elements :order do
+                    eval(ELEMENTS)
+                  end
+                end
+              end
+            end
+
+            action :find_order, :url => '/orders/:id.xml' do
+              parser Parsers::OrderParser do
+                element :order do
+                  eval(ELEMENTS)
+                end
+              end
+            end
+
+            action :modify_order, :url => '/orders/:id/modify.xml', :method => :put do
+              parameter 'order[state]', :as => :state, :required => true
+              parser Parsers::OrderParser do
+                element :order do
+                  eval(ELEMENTS)
+                end
+              end
+            end
+
+            action :domain_approvers, :url => '/orders/approvers.xml' do
+              parameter :domain, :required => true
+              parser :emails do
+                element :emails do
+                  elements :email
+                end
+              end
+            end
+
+            action :resend_approval_email, :url => '/orders/:id/resend.xml', :method => :post do
+              parser Parsers::OrderParser do
+                element :order do
+                  eval(ELEMENTS)
+                end
+              end
+            end
+
+            action :change_order_approval_email, :url => '/orders/:id/email.xml', :method => :put do
+              parameter 'order[approver_email]', :as => :approver_email, :required => true
+              parser Parsers::OrderParser do
+                element :order do
+                  eval(ELEMENTS)
+                end
+              end
+            end
+
+            action :create_order, :url => '/orders.xml', :method => :post do
+              parameter 'order[years]',                   :as => :years
+              parameter 'order[licenses]',                :as => :licenses
+              parameter 'order[dns_names]',               :as => :sans
+              parameter 'order[approver_email]',          :as => :approver_email
+
+              parameter 'order[product][sku]',            :as => :product_sku
+              parameter 'order[csr][body]',               :as => :csr_body
+
+              parameter 'order[ev_approver][first_name]', :as => :ev_approver_first_name
+              parameter 'order[ev_approver][last_name]',  :as => :ev_approver_last_name
+              parameter 'order[ev_approver][title]',      :as => :ev_approver_title
+              parameter 'order[ev_approver][phone]',      :as => :ev_approver_phone
+              parameter 'order[ev_approver][email]',      :as => :ev_approver_email
+
+              parameter 'order[admin][first_name]',       :as => :administrator_first_name
+              parameter 'order[admin][last_name]',        :as => :administrator_last_name
+              parameter 'order[admin][phone]',            :as => :administrator_phone
+              parameter 'order[admin][email]',            :as => :administrator_email
+
+              parameter 'order[organization][organization_name]', :as => :organization_name
+              parameter 'order[organization][address]',           :as => :organization_address
+              parameter 'order[organization][city]',              :as => :organization_city
+              parameter 'order[organization][state]',             :as => :organization_state
+              parameter 'order[organization][postal_code]',       :as => :organization_postal_code
+              parameter 'order[organization][phone]',             :as => :organization_phone
+              
+              parser Parsers::OrderParser do
+                element :order do
+                  eval(ELEMENTS)
+                end
+              end
+            end
+
+            action :validate_order, :url => '/orders/validate.xml', :method => :post do
+              parameter 'order[product][sku]',  :as => :product_sku
+              parameter 'order[csr][body]',     :as => :csr_body
+              parameter 'order[years]',         :as => :years
+              parameter 'order[licenses]',      :as => :licenses
+              parameter 'order[dns_names]',     :as => :sans
+
+              parser Parsers::OrderParser do
+                element :order do
+                  element 'total-price',        :as => :total_price,        :type => Float
+
+                  element :csr do
+                    element 'common-name',      :as => :common_name
+                    element :city
+                    element :state
+                    element :country
+                    element :organization
+                    element 'org-unit',         :as => :organizational_unit
+                    element :body
+                  end
+
+                  element 'renewal-info',       :as => :renewal_information do
+                    element :indicator
+                    element :months,                                        :type => Integer
+                    element 'serial-number',    :as => :serial_number
+                    element 'order-id',         :as => :order_id
+                    element 'expiration-date',  :as => :expires_at,         :type => DateTime
+                  end
+
+                  element :warnings do
+                    elements :warning do
+                      element :code, :type => Float
+                      element :message
+                    end
+                  end
+
+                end
+              end
+            end
+
+          end
+        end
+      end
+
+    end
+
+  end
+end