elephant-drive-service 0.1.5

data/lib/elephant-drive-service.rb

@@ -0,0 +1,39 @@
+# -*- encoding : utf-8 -*-
+
+require 'savon'
+
+require_relative 'elephant-drive-service/result_extractor'
+require_relative 'elephant-drive-service/message_builder'
+require_relative 'elephant-drive-service/response_builder'
+require_relative 'elephant-drive-service/config'
+require_relative 'elephant-drive-service/base_service'
+require_relative 'elephant-drive-service/provisioning_service'
+require_relative 'elephant-drive-service/report_service'
+
+module ElephantDriveService
+  extend self
+
+  def ws_config
+    @ws_config
+  end
+
+  def ws_config= config
+    @ws_config = config
+  end
+
+  def user_portal_domain
+    "https://#{@domain || 'locaweb.vaultservices.net'}"
+  end
+
+  def user_portal_domain= domain
+    @domain = domain
+  end
+
+  def change_password_path token
+    "/account/change_password.aspx?id=#{token}"
+  end
+
+  def self.configure
+    yield self
+  end
+end

data/lib/elephant-drive-service/base_service.rb

@@ -0,0 +1,44 @@
+# -*- encoding : utf-8 -*-
+
+module ElephantDrive
+  class BaseService
+    include MessageBuilder
+    include ResponseBuilder
+
+    def initialize custom_config=nil
+      @config = custom_config ? custom_config : ElephantDrive::ServiceConfig.new(ElephantDriveService.ws_config)
+      full_config = @config.to_hash
+      full_config = full_config.merge(proxy: ENV['http_proxy']) if ENV && ENV['http_proxy']
+      @client = Savon.client(full_config)
+    end
+
+    private
+    def partner_login_message
+      {ac: {user: @config.username, pass: @config.hashed_password, salt: Time.now.strftime('%Y/%m/%d %H:%M:%S'), code: { g_product_code: @config.product_code, version: @config.version}}}
+    end
+
+    def execute! action_name
+      extractor = execute(action_name) do
+        { message: yield }
+      end
+      raise extractor[:method_detail] unless extractor[:method_result] == 'Success'
+      extractor
+    end
+
+    def execute action
+      authenticate_and_go do |session_id|
+        call_params = yield
+        call_params[:message] = { 'gSessionID' => session_id }.merge(call_params[:message])
+        ElephantDrive::ResultExtractor.new(action, @client.call(action, call_params))
+      end
+    end
+
+    def authenticate_and_go
+      raise ArgumentError, 'a block is needed for post actions' unless block_given?
+
+      extractor = ElephantDrive::ResultExtractor.new(:partner_login, @client.call(:partner_login, message: partner_login_message) )
+      raise 'not authorized' unless extractor[:method_result] == 'Success'
+      yield extractor[:g_session_id]
+    end
+  end
+end

data/lib/elephant-drive-service/config.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+
+module ElephantDrive
+  class ServiceConfig
+    def initialize yaml
+      yaml[:ws].each do |key,value|
+        var_name = "@#{key.to_s}"
+        self.instance_variable_set(var_name,value)
+        self.class.class_eval { attr_reader key }
+      end
+    end
+
+    def to_hash
+      Hash[instance_variables.map { |var| [var[1..-1].to_sym, instance_variable_get(var)] }].select { |k,v| [:wsdl, :log_level, :log, :ssl_verify_mode].include? k }
+    end
+
+    def hashed_password
+      elephant_hash(password)
+    end
+
+    private
+    def elephant_hash(pw, hash=true)
+      return pw if pw.empty?
+      pw = Digest::MD5.hexdigest(pw) if hash
+      pw =~ /(..)(.*)/
+      $1.hex.to_s + elephant_hash($2, false)
+    end
+  end
+end

data/lib/elephant-drive-service/message_builder.rb

@@ -0,0 +1,103 @@
+# -*- encoding : utf-8 -*-
+
+module ElephantDrive
+  module MessageBuilder
+    def add_customer_message customer, campaign_id
+      {
+        'strIP' => '127.0.0.1',
+        'iCampID' => campaign_id,
+        'strCompany' => '',
+        'strEmail' => customer.email,
+        'strDisplayName' => '',
+        'strPswd' => '123inicial',
+        'iSubType' => customer.plan.subscription_type_id,
+        'strOrderId' => '',
+        'strCustomTrack' => ''
+      }
+    end
+
+    def modify_subscription_message provisioning, new_plan
+      {
+        'strIP' => '127.0.0.1',
+        'gUserID' => provisioning.installed_user_id,
+        'iSubType' => new_plan.subscription_type_id
+      }
+    end
+
+    def deactivate_customer_message installed_user_id
+      {
+        'strIP' => '127.0.0.1',
+        'gUserID' => installed_user_id,
+        'asAcctState' => 'SuspendedbyAccountAdministrator',
+        'strDesc' => ''
+      }
+    end
+
+    def reactivate_customer_message provisioning
+      {
+        'gUserID' => provisioning.installed_user_id,
+        'strEmail' => '',
+        'strDisplayName' => '',
+        'strIP' => '',
+        'strDesc' => ''
+      }
+    end
+
+    def search_customer_message email
+      {
+        'strSearchText' => email,
+        'scrCriterion' => 'Exact',
+        'scCategory' => 'Email',
+      }
+    end
+
+    def check_username_availability_message email
+      {
+        'user' => email,
+        'iType' => 1
+      }
+    end
+
+    def customer_list_message params
+      {
+        'iPartnerID' => params[:partner_id],
+        'dtStartReg' => params[:starting_registration_date],
+        'dtEndReg' => params[:ending_registration_date],
+        'iMaxRow' => params[:max_rows],
+        'zSendEmail' => params[:send_email],
+        'strEmail' => params[:email_to_send],
+        'rf' => "csv",
+        'iCampIDs' => {
+          'int' => params[:campaign_id]
+        }
+      }
+    end
+
+    def base_user_message provisioning
+      {
+        'gUserID' => provisioning.installed_user_id,
+      }
+    end
+
+    def reset_password_message installed_user_id
+      {
+        'gUserID' => installed_user_id,
+        'strIP' => '127.0.0.1'
+      }
+    end
+
+    def get_customer_list_by_reg_date_message partner_id, end_date
+      {
+        'iPartnerID' => partner_id,
+        'dtStartReg' => Time.utc(1970,1,01,0,0,0).iso8601,
+        'dtEndReg' => end_date.iso8601,
+        'iMaxRow' => -1,
+        'zSendEmail' => false,
+        'strEmail' => '',
+        'rf' => 'csv',
+        'iCampIDs' => { 'int' => 1010 }
+      }
+    end
+    
+  end
+end

data/lib/elephant-drive-service/provisioning_service.rb

@@ -0,0 +1,66 @@
+# -*- encoding : utf-8 -*-
+
+module ElephantDrive
+  class ProvisioningService < BaseService
+
+    def add_a_customer customer
+      add_extractor = execute(:add_customer_with_partner_billing) {
+        { message: add_customer_message(customer, @config.campaign_id), soap_action: 'http://svc.elephantdrive.com/ese/AddCustomerWithPartnerBillingCustomTrack' }
+      }.ending_with(:custom_track)
+
+      generate_add_customer_response add_extractor, generate_reset_password_token(add_extractor[:g_user_id])
+    end
+
+    def modify_subscription provisioning, new_plan
+      execute! :modify_sub_with_partner_billing do
+        modify_subscription_message(provisioning, new_plan)
+      end
+    end
+
+    def deactivate_customer provisioning
+      execute! :deactivate_customer do
+        deactivate_customer_message provisioning.installed_user_id
+      end
+    end
+
+    def reactivate_customer provisioning
+      execute! :reactivate_customer do
+        reactivate_customer_message provisioning
+      end
+    end
+
+    def delete_customer provisioning
+      execute! :deactivate_customer do
+        deactivate_customer_message(provisioning.installed_user_id).merge('asAcctState' => 'CancelledbyAccountAdministrator')
+      end
+    end
+
+    def get_user_usage provisioning
+      extractor = execute :get_partner_user_usage do
+        { message: base_user_message(provisioning) }
+      end
+      raise extractor[:state] unless extractor[:state] == 'OK'
+      generate_usage_statistics extractor
+    end
+
+    def username_available? email
+      extractor = execute(:check_username_availability) do
+        { message: check_username_availability_message(email), soap_action: 'http://svc.elephantdrive.com/ese/SCheckUsernameAvailability' }
+      end
+      !extractor.starting_with(:s)[:result]
+    end
+
+    private
+    def generate_reset_password_token installed_user_id
+      execute!(:log_customer_reset_pswd_request) do
+        reset_password_message(installed_user_id)
+      end
+    rescue => e
+      execute! :deactivate_customer do
+        deactivate_customer_message(installed_user_id).merge('asAcctState' => 'CancelledbyAccountAdministrator')
+      end
+
+      raise e
+    end
+  end
+end

data/lib/elephant-drive-service/report_service.rb

@@ -0,0 +1,18 @@
+# -*- encoding : utf-8 -*-
+
+module ElephantDrive
+  class ReportService < BaseService
+    
+    def average_usage_report snapshot_date
+      extractor = execute(:get_customer_list) {
+        { message: get_customer_list_by_reg_date_message(@config.partner_id,snapshot_date),
+          soap_action: "http://svc.elephantdrive.com/ese/GetCustomerListByRegDateAndMaxRow" }
+      }.ending_with(:by_reg_date_and_max_row)
+
+      raise extractor[:method_detail] unless extractor[:method_result] == 'Success'
+
+      generate_average_usage_report_response extractor
+    end
+
+  end
+end

data/lib/elephant-drive-service/response_builder.rb

@@ -0,0 +1,55 @@
+# -*- encoding : utf-8 -*-
+
+module ElephantDrive
+  module ResponseBuilder
+    def generate_usage_statistics extractor
+      total_capacity = extractor[:l_capacity_bytes].to_f
+      total_usage = [extractor[:l_active_length].to_f,extractor[:l_version_length].to_f,extractor[:l_trash_length].to_f].inject(:+)
+
+      { total_capacity: total_capacity, total_usage: total_usage, usage_rate: total_usage/total_capacity }
+    end
+
+    def generate_add_customer_response add_extractor, password_change_extractor
+      { installed_user_id: add_extractor[:g_user_id], reset_password_url: ElephantDriveService.user_portal_domain + ElephantDriveService.change_password_path(password_change_extractor[:message]) }
+    end
+
+    def generate_average_usage_report_response extractor
+      {data: [], 
+       total_capacity: 0.0, 
+       total_active_usage: 0.0,
+       total_inactive_usage: 0.0,
+       total_usage_percentage: 0.0,
+       total_active_usage_percentage: 0.0,
+       total_inactive_usage_percentage: 0.0}.tap do |report|
+        [extractor[:ds][:diffgram].fetch(:new_data_set,{}).fetch(:table,[])].flatten.select { |h| h[:str_email] }.each do |user|
+          {
+            display_name: user[:str_display_name],
+            email: user[:str_email],
+            installed_user_id: user[:g_user_id],
+            status: user[:str_account_state],
+            total_capacity: user[:l_capacity_b].to_f,
+            total_usage: user[:l_usage_b].to_f || 0.0
+          }.tap { |entry|
+            entry[:usage_percentage] = entry[:total_usage] / entry[:total_capacity]
+
+            if entry[:status] =~ /^Suspended|Active/i
+              report[:total_capacity] += entry[:total_capacity]
+              case entry[:status]
+                when /^Active/i
+                  report[:total_active_usage] += entry[:total_usage]
+                  report[:total_active_usage_percentage] = entry[:total_usage] / entry[:total_capacity]
+                when /^Suspended/i
+                  report[:total_inactive_usage] += entry[:total_usage]
+                  report[:total_inactive_usage_percentage] = entry[:total_usage] / entry[:total_capacity]
+              end
+            end
+
+            report[:data] << entry
+          }
+        end
+
+        report[:total_usage_percentage] = ((report[:total_active_usage] + report[:total_inactive_usage]) / report[:total_capacity]).round(2) if report[:total_capacity] > 0.0
+      end
+    end
+  end
+end

data/lib/elephant-drive-service/result_extractor.rb

@@ -0,0 +1,33 @@
+# -*- encoding : utf-8 -*-
+
+module ElephantDrive
+  class ResultExtractor
+    def initialize action, response
+      @action = action
+      @response_name = "#{@action}_response".to_sym
+      @result_name = "#{@action}_result".to_sym
+      @response = response
+    end
+
+    def [] name
+      case name
+        when :result
+          @response.body[@response_name][@result_name]
+        else
+          @response.body[@response_name][@result_name][name]
+      end
+    end
+
+    def ending_with suffix
+      @response_name = "#{@action}_#{suffix}_response".to_sym
+      @result_name = "#{@action}_#{suffix}_result".to_sym
+      self
+    end
+
+    def starting_with prefix
+      @response_name = "#{prefix}_#{@action}_response".to_sym
+      @result_name = "#{prefix}_#{@action}_result".to_sym
+      self
+    end
+  end
+end

data/lib/elephant-drive-service/version.rb

@@ -0,0 +1,5 @@
+# -*- encoding : utf-8 -*-
+
+module ElephantDriveService
+  VERSION = "0.1.5"
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: elephant-drive-service
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+  prerelease: 
+platform: ruby
+authors:
+- Equipe de soluções de atendimento
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Client SOAP para integração com os serviços do ElephantDrive
+email:
+- saas-dev@locaweb.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/elephant-drive-service/base_service.rb
+- lib/elephant-drive-service/config.rb
+- lib/elephant-drive-service/message_builder.rb
+- lib/elephant-drive-service/provisioning_service.rb
+- lib/elephant-drive-service/report_service.rb
+- lib/elephant-drive-service/response_builder.rb
+- lib/elephant-drive-service/result_extractor.rb
+- lib/elephant-drive-service/version.rb
+- lib/elephant-drive-service.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []