Class: OpenX::Services::Base

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/openx/services/base.rb

Direct Known Subclasses

Advertiser, Agency, Banner, Campaign, Publisher, Zone

Constant Summary collapse

CONFIGURATION_YAML =

HOME || HOMEPATH is for Win32 users who do not have HOME set by default

Configuration can be overridden for Rails at load time by doing this: OpenX::Services::Base.configuration = 

YAML.load_file(File.join(Rails.root, 'config', 'credentials.yml'))[Rails.env]

Rescue nil is there for Rails sites that are monitored by Monit, which does not set the environment variables as expected. Note that the configuration can be set explicitly (as above), in which case this constant is not used and can safely be nil.

File.join((ENV['HOME'] || ENV['HOMEPATH']), '.openx', 'credentials.yml') rescue nil
@@connection = 
nil
@@configuration = 
nil

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(params = {}) ⇒ Base

Returns a new instance of Base.



99
100
101
102
103
 
# File 'lib/openx/services/base.rb', line 99

def initialize(params = {})
  @id = nil
  params.each { |k,v| send(:"#{k}=", v) }
  @server = XmlrpcClient.new2("#{self.class.connection.url}")
end

Class Attribute Details

.create ⇒ Object

Returns the value of attribute create.



25
26
27
 
# File 'lib/openx/services/base.rb', line 25

def create
  @create
end

.delete ⇒ Object

Returns the value of attribute delete.



25
26
27
 
# File 'lib/openx/services/base.rb', line 25

def delete
  @delete
end

.find_all ⇒ Object

Returns the value of attribute find_all.



25
26
27
 
# File 'lib/openx/services/base.rb', line 25

def find_all
  @find_all
end

.find_one ⇒ Object

Returns the value of attribute find_one.



25
26
27
 
# File 'lib/openx/services/base.rb', line 25

def find_one
  @find_one
end

.translations ⇒ Object

Returns the value of attribute translations.



24
25
26
 
# File 'lib/openx/services/base.rb', line 24

def translations
  @translations
end

.update ⇒ Object

Returns the value of attribute update.



25
26
27
 
# File 'lib/openx/services/base.rb', line 25

def update
  @update
end

Class Method Details

.configuration ⇒ Object 



27
28
29
30
 
# File 'lib/openx/services/base.rb', line 27

def configuration
  @@configuration ||=
    YAML.load_file(CONFIGURATION_YAML)[ENV['OPENX_ENV'] || 'production']
end

.configuration=(c) ⇒ Object 



32
 
# File 'lib/openx/services/base.rb', line 32

def configuration=(c); @@configuration = c; end

.connection ⇒ Object 



38
39
40
41
42
43
44
45
46
 
# File 'lib/openx/services/base.rb', line 38

def connection
  unless @@connection
    @@connection = Session.new(configuration['url'])
    @@connection.create( configuration['username'],
                        configuration['password']
                      )
  end
  @@connection
end

.connection=(c) ⇒ Object 



34
35
36
 
# File 'lib/openx/services/base.rb', line 34

def connection= c
  @@connection = c
end

.create!(params = {}) ⇒ Object 



48
49
50
 
# File 'lib/openx/services/base.rb', line 48

def create!(params = {})
  new(params).save!
end

.destroy(id) ⇒ Object 



85
86
87
 
# File 'lib/openx/services/base.rb', line 85

def destroy(id)
  new(:id => id).destroy
end

.find(id, *args) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/openx/services/base.rb', line 71

def find(id, *args)
  session   = self.connection
  server    = XmlrpcClient.new2("#{session.url}")
  if id == :all
    responses = server.call(find_all(), session, *args)
    responses.map { |response|
      new(translate(response))
    }
  else
    response  = server.call(find_one(), session, id)
    new(translate(response))
  end
end

.has_one(*things) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/openx/services/base.rb', line 60

def has_one(*things)
  things.each do |thing|
    attr_writer :"#{thing}"
    define_method(:"#{thing}") do
      klass = thing.to_s.capitalize.gsub(/_[a-z]/) { |m| m[1].chr.upcase }
      klass = OpenX::Services.const_get(:"#{klass}")
      klass.find(send("#{thing}_id"))
    end
  end
end

.openx_accessor(accessor_map) ⇒ Object 



52
53
54
55
56
57
58
 
# File 'lib/openx/services/base.rb', line 52

def openx_accessor(accessor_map)
  @translations ||= {}
  @translations = accessor_map.merge(@translations)
  accessor_map.each do |ruby,openx|
    attr_accessor :"#{ruby}"
  end
end

Instance Method Details

#<=>(other) ⇒ Object 



129
130
131
 
# File 'lib/openx/services/base.rb', line 129

def <=>(other)
  self.id <=> other.id
end

#destroy ⇒ Object 



123
124
125
126
127
 
# File 'lib/openx/services/base.rb', line 123

def destroy
  session = self.class.connection
  @server.call(self.class.delete, session, id)
  @id = nil
end

#new_record? ⇒ Boolean

Returns:

  • (Boolean) 


105
 
# File 'lib/openx/services/base.rb', line 105

def new_record?; @id.nil?; end

#save! ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/openx/services/base.rb', line 107

def save!
  params = {}
  session = self.class.connection
  self.class.translations.keys.each { |k|
    value = send(:"#{k}")
    params[self.class.translations[k].to_s] = value if value
  }

  if new_record?
    @id = @server.call(self.class.create, session, params)
  else
    @server.call(self.class.update, session, params)
  end
  self
end