Class: Frodo::Service

Inherits:
Object
  • Object
show all
Defined in:
lib/frodo/service.rb

Overview

Encapsulates the basic details and functionality needed to interact with an Frodo service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_url, options = {}, &block) ⇒ Frodo::Service

Opens the service based on the requested URL and adds the service to Registry

Parameters:

  • service_url (String) —

    The URL to the Frodo service

  • options (Hash) (defaults to: {}) —

    options to pass to the service



19
20
21
22
23
24
25
 
# File 'lib/frodo/service.rb', line 19

def initialize(service_url, options = {}, &block)
  @options = default_options.merge(options)
  @service_url = service_url

  Frodo::ServiceRegistry.add(self)
  register_custom_types
end

Instance Attribute Details

#options ⇒ Object (readonly)

Service options



9
10
11
 
# File 'lib/frodo/service.rb', line 9

def options
  @options
end

#service_url ⇒ Object (readonly)

The Frodo Service’s URL



7
8
9
 
# File 'lib/frodo/service.rb', line 7

def service_url
  @service_url
end

Instance Method Details

#[](entity_set_name) ⇒ Frodo::EntitySet

Retrieves the EntitySet associated with a specific EntityType by name

Parameters:

  • entity_set_name (to_s) —

    the name of the EntitySet desired

Returns:



72
73
74
75
76
77
78
 
# File 'lib/frodo/service.rb', line 72

def [](entity_set_name)
  if with_metadata?
    entity_container[entity_set_name]
  else
    EntitySet.new(name: entity_set_name)
  end
end

#complex_types ⇒ Hash<String, Frodo::Schema::ComplexType>

Returns a list of ‘ComplexType`s used by the service.

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/frodo/service.rb', line 99

def complex_types
  @complex_types ||= schemas.map do |namespace, schema|
    schema_hash = {}
    schema.complex_types.map do |name, complex_type|
      schema_hash["#{namespace}.#{name}"] = complex_type
      if schema.alias
        schema_hash["#{schema.alias}.#{name}"] = complex_type
      end
    end
    schema_hash
  end.reduce({}, :merge)
end

#entity_container ⇒ Object

Returns the service’s EntityContainer (singleton)

Returns:

  • Frodo::EntityContainer



58
59
60
 
# File 'lib/frodo/service.rb', line 58

def entity_container
  @entity_container ||= EntityContainer.new(self)
end

#entity_sets ⇒ Object

Returns a hash of EntitySet names and their respective EntityType names



64
65
66
 
# File 'lib/frodo/service.rb', line 64

def entity_sets
  entity_container.entity_sets
end

#entity_types ⇒ Object

Returns a list of ‘EntityType`s exposed by the service



89
90
91
92
93
94
95
 
# File 'lib/frodo/service.rb', line 89

def entity_types
  @entity_types ||= schemas.map do |namespace, schema|
    schema.entity_types.map do |entity_type|
      "#{namespace}.#{entity_type}"
    end
  end.flatten
end

#enum_types ⇒ Hash<String, Frodo::Schema::EnumType>

Returns a list of ‘EnumType`s used by the service

Returns:



114
115
116
117
118
119
120
 
# File 'lib/frodo/service.rb', line 114

def enum_types
  @enum_types ||= schemas.map do |namespace, schema|
    schema.enum_types.map do |name, enum_type|
      [ "#{namespace}.#{name}", enum_type ]
    end.to_h
  end.reduce({}, :merge)
end

#get_property_type(entity_name, property_name) ⇒ String

Get the property type for an entity from metadata.

Parameters:

  • entity_name (to_s) —

    the fully qualified entity name

  • property_name (to_s) —

    the property name needed

Returns:

  • (String) —

    the name of the property’s type

Raises:

  • (ArgumentError) 


132
133
134
135
136
 
# File 'lib/frodo/service.rb', line 132

def get_property_type(entity_name, property_name)
  namespace, _, entity_name = entity_name.rpartition('.')
  raise ArgumentError, 'Namespace missing' if namespace.nil? || namespace.empty?
  schemas[namespace].get_property_type(entity_name, property_name)
end

#inspect ⇒ Object

Returns a more compact inspection of the service object



123
124
125
 
# File 'lib/frodo/service.rb', line 123

def inspect
  "#<#{self.class.name}:#{self.object_id} name='#{name}' service_url='#{self.service_url}'>"
end

#logger ⇒ Logger

Returns the logger instance used by the service. When Ruby on Rails has been detected, the service will use ‘Rails.logger`. The log level will NOT be changed.

When no Rails has been detected, a default logger will be used that logs to STDOUT with the log level supplied via options, or the default log level if none was given.

Returns:

  • (Logger) 


167
168
169
170
171
172
173
 
# File 'lib/frodo/service.rb', line 167

def logger
  @logger ||= options[:logger] || if defined?(Rails)
    Rails.logger
  else
    default_logger
  end
end

#metadata ⇒ Nokogiri::XML

Returns the service’s metadata definition.

Returns:

  • (Nokogiri::XML) 


41
42
43
 
# File 'lib/frodo/service.rb', line 41

def metadata
  @metadata ||= lambda { read_metadata }.call
end

#metadata_url ⇒ String

Returns the service’s metadata URL.

Returns:

  • (String) 


35
36
37
 
# File 'lib/frodo/service.rb', line 35

def metadata_url
  "#{service_url}/$metadata"
end

#name ⇒ String

Returns user supplied name for service, or its URL

Returns:

  • (String) 


29
30
31
 
# File 'lib/frodo/service.rb', line 29

def name
  @name ||= options[:name] || service_url
end

#namespace ⇒ String

Returns the default namespace, that is, the namespace of the schema that contains the service’s EntityContainer.

Returns:

  • (String) 


83
84
85
 
# File 'lib/frodo/service.rb', line 83

def namespace
  entity_container.namespace
end

#primary_key_for(entity_name) ⇒ String

Get the primary key for the supplied Entity.

Parameters:

  • entity_name (to_s) —

    The fully qualified entity name

Returns:

  • (String)

Raises:

  • (ArgumentError) 


142
143
144
145
146
 
# File 'lib/frodo/service.rb', line 142

def primary_key_for(entity_name)
  namespace, _, entity_name = entity_name.rpartition('.')
  raise ArgumentError, 'Namespace missing' if namespace.nil? || namespace.empty?
  schemas[namespace].primary_key_for(entity_name)
end

#properties_for_entity(entity_name) ⇒ Hash

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Get the list of properties and their various options for the supplied Entity name.

Parameters:

  • entity_name (to_s)

Returns:

  • (Hash)

Raises:

  • (ArgumentError) 


153
154
155
156
157
 
# File 'lib/frodo/service.rb', line 153

def properties_for_entity(entity_name)
  namespace, _, entity_name = entity_name.rpartition('.')
  raise ArgumentError, 'Namespace missing' if namespace.nil? || namespace.empty?
  schemas[namespace].properties_for_entity(entity_name)
end

#schemas ⇒ Object

Returns all of the service’s schemas.



47
48
49
50
51
52
53
54
 
# File 'lib/frodo/service.rb', line 47

def schemas
  @schemas ||= metadata.xpath('//Schema').map do |schema_xml|
    [
      schema_xml.attributes['Namespace'].value,
      Schema.new(schema_xml, self, options[:navigation_properties])
    ]
  end.to_h
end

#with_metadata? ⇒ Boolean

Returns:

  • (Boolean) 


175
176
177
 
# File 'lib/frodo/service.rb', line 175

def with_metadata?
  !options.key?(:with_metadata) || options[:with_metadata]
end