Class: DuodealerAPI::Base

Inherits:
ActiveResource::Base
  • Object
show all
Extended by:
Countable
Defined in:
lib/duodealer_api/resources/base.rb

Defined Under Namespace

Classes: InvalidSessionError

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Countable

count

Class Method Details

.activate_session(session) ⇒ Object

Raises:



45
46
47
48
49
50
 
# File 'lib/duodealer_api/resources/base.rb', line 45

def activate_session(session)
  raise InvalidSessionError.new("Session cannot be nil") if session.nil?
  self.site = session.site
  self.headers.merge!('X-DuoDealer-Access-Token' => session.token)
  self.api_version = session.api_version
end

.api_version ⇒ Object 



60
61
62
63
64
65
66
67
68
 
# File 'lib/duodealer_api/resources/base.rb', line 60

def api_version
  if _api_version_defined?
    _api_version
  elsif superclass != Object && superclass.site
    superclass.api_version.dup.freeze
  else
    ApiVersion::NullVersion
  end
end

.api_version=(version) ⇒ Object 



70
71
72
 
# File 'lib/duodealer_api/resources/base.rb', line 70

def api_version=(version)
  self._api_version = ApiVersion::NullVersion.matches?(version) ? ApiVersion::NullVersion : ApiVersion.find_version(version)
end

.clear_session ⇒ Object 



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

def clear_session
  self.site = nil
  self.password = nil
  self.user = nil
  self.api_version = nil
  self.headers.delete('X-DuoDealer-Access-Token')
end

.early_july_pagination? ⇒ Boolean

Returns:

  • (Boolean) 


131
132
133
 
# File 'lib/duodealer_api/resources/base.rb', line 131

def early_july_pagination?
  !!early_july_pagination
end

.headers ⇒ Object 



35
36
37
38
39
40
41
42
43
 
# File 'lib/duodealer_api/resources/base.rb', line 35

def headers
  if _headers_defined?
    _headers
  elsif superclass != Object && superclass.headers
    superclass.headers
  else
    _headers ||= {}
  end
end

.init_prefix(resource) ⇒ Object 



119
120
121
 
# File 'lib/duodealer_api/resources/base.rb', line 119

def init_prefix(resource)
  init_prefix_explicit(resource.to_s.pluralize, "#{resource}_id")
end

.init_prefix_explicit(resource_type, resource_id) ⇒ Object 



123
124
125
126
127
128
129
 
# File 'lib/duodealer_api/resources/base.rb', line 123

def init_prefix_explicit(resource_type, resource_id)
  self.resource_prefix = "#{resource_type}/:#{resource_id}/"

  define_method resource_id.to_sym do
    @prefix_options[resource_id]
  end
end

.prefix(options = {}) ⇒ Object 



74
75
76
 
# File 'lib/duodealer_api/resources/base.rb', line 74

def prefix(options = {})
  api_version.construct_api_path(resource_prefix(options))
end

.prefix=(value) ⇒ Object Also known as: set_prefix 



105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/duodealer_api/resources/base.rb', line 105

def prefix=(value)
  if value.start_with?('/admin')
    raise ArgumentError, "'#{value}' can no longer start /admin/. Change to using resource_prefix="
  end

  warn(
    '[DEPRECATED] DuodealerAPI::Base#prefix= is deprecated and will be removed in a future version. ' \
      'Use `self.resource_prefix=` instead.'
  )
  self.resource_prefix = value
end

.prefix_source ⇒ Object 



78
79
80
 
# File 'lib/duodealer_api/resources/base.rb', line 78

def prefix_source
  ''
end

.resource_prefix(_options = {}) ⇒ Object 



82
83
84
 
# File 'lib/duodealer_api/resources/base.rb', line 82

def resource_prefix(_options = {})
  ''
end

.resource_prefix=(value) ⇒ Object

Sets the prefix for a resource’s nested URL (e.g., prefix/collectionname/1.json). Default value is site.path.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/duodealer_api/resources/base.rb', line 88

def resource_prefix=(value)
  @prefix_parameters = nil

  resource_prefix_call = value.gsub(/:\w+/) { |key| "\#{URI.parser.escape options[#{key}].to_s}" }

  silence_warnings do
    # Redefine the new methods.
    instance_eval "      def prefix_source() \"\#{value}\" end\n      def resource_prefix(options={}) \"\#{resource_prefix_call}\" end\n    RUBY_EVAL\n  end\nrescue => e\n  logger&.error(\"Couldn't set prefix: \#{e}\\n  \#{code}\")\n  raise\nend\n", __FILE__, __LINE__ + 1

.version_validation!(minimum_version) ⇒ Object 



135
136
137
138
139
140
141
 
# File 'lib/duodealer_api/resources/base.rb', line 135

def version_validation!(minimum_version)
  available_in_version = DuodealerAPI::ApiVersion.find_version(minimum_version)

  unless DuodealerAPI::Base.api_version >= available_in_version
    raise NotImplementedError, "The minimum supported version is #{minimum_version}."
  end
end

Instance Method Details

#as_json(options = nil) ⇒ Object 



23
24
25
26
27
28
29
30
31
 
# File 'lib/duodealer_api/resources/base.rb', line 23

def as_json(options = nil)
  root = options[:root] if options.try(:key?, :root)
  if include_root_in_json
    root = self.class.model_name.element if root == true
    { root => serializable_hash(options) }
  else
    serializable_hash(options)
  end
end

#encode(options = {}) ⇒ Object 



16
17
18
19
20
21
 
# File 'lib/duodealer_api/resources/base.rb', line 16

def encode(options = {})
  same = dup
  same.attributes = {self.class.element_name => same.attributes} if self.class.format.extension == 'json'

  same.send("to_#{self.class.format.extension}", options)
end

#persisted? ⇒ Boolean

Returns:

  • (Boolean) 


152
153
154
 
# File 'lib/duodealer_api/resources/base.rb', line 152

def persisted?
  !id.nil?
end