Class: Megam::JSONCompat

Inherits:
Object
  • Object
show all
Defined in:
lib/megam/core/json_compat.rb

Constant Summary collapse

JSON_MAX_NESTING = 
1000
JSON_CLAZ = 
"json_claz".freeze
MEGAM_ACCOUNT = 
"Megam::Account".freeze
MEGAM_ASSEMBLIES = 
"Megam::Assemblies".freeze
MEGAM_ASSEMBLIESCOLLECTION = 
"Megam::AssembliesCollection".freeze
MEGAM_ASSEMBLY = 
"Megam::Assembly".freeze
MEGAM_ASSEMBLYCOLLECTION = 
"Megam::AssemblyCollection".freeze
MEGAM_AUTH = 
"Megam::Auth".freeze
MEGAM_AVAILABLEUNITS = 
"Megam::Availableunits".freeze
MEGAM_AVAILABLEUNITSCOLLECTION = 
"Megam::AvailableunitsCollection".freeze
MEGAM_BALANCES = 
"Megam::Balances".freeze
MEGAM_BALANCESCOLLECTION = 
"Megam::BalancesCollection".freeze
MEGAM_BILLEDHISTORIES = 
"Megam::Billedhistories".freeze
MEGAM_BILLEDHISTORIESCOLLECTION = 
"Megam::BilledhistoriesCollection".freeze
MEGAM_INVOICESCOLLECTION = 
"Megam::InvoicesCollection".freeze
MEGAM_INVOICES = 
"Megam::Invoices".freeze
MEGAM_BILLINGSCOLLECTION = 
"Megam::BillingsCollection".freeze
MEGAM_CLOUDTOOLSETTING = 
"Megam::CloudToolSetting".freeze
MEGAM_CLOUDTOOLSETTINGCOLLECTION = 
"Megam::CloudToolSettingCollection".freeze
MEGAM_COMPONENTS = 
"Megam::Components".freeze
MEGAM_COMPONENTSCOLLECTION = 
"Megam::ComponentsCollection".freeze
MEGAM_CREDITHISTORIES = 
"Megam::Credithistories".freeze
MEGAM_CREDITHISTORIESCOLLECTION = 
"Megam::CredithistoriesCollection".freeze
MEGAM_CSAR = 
"Megam::CSAR".freeze
MEGAM_CSARCOLLECTION = 
"Megam::CSARCollection".freeze
MEGAM_DOMAIN = 
"Megam::Domains".freeze
MEGAM_DISCOUNTS = 
"Megam::Discounts".freeze
MEGAM_DISCOUNTSCOLLECTION = 
"Megam::DiscountsCollection".freeze
MEGAM_ERROR = 
"Megam::Error".freeze
MEGAM_EVENT = 
"Megam::Event".freeze
MEGAM_MARKETPLACE = 
"Megam::MarketPlace".freeze
MEGAM_MARKETPLACECOLLECTION = 
"Megam::MarketPlaceCollection".freeze
MEGAM_MARKETPLACEADDON = 
"Megam::MarketPlaceAddons".freeze
MEGAM_MARKETPLACEADDONCOLLECTION = 
"Megam::MarketPlaceAddonsCollection".freeze
MEGAM_ORGANIZATION = 
"Megam::Organizations".freeze
MEGAM_ORGANIZATIONSCOLLECTION = 
"Megam::OrganizationsCollection".freeze
MEGAM_REQUEST = 
"Megam::Request".freeze
MEGAM_REQUESTCOLLECTION = 
"Megam::RequestCollection".freeze
MEGAM_SSHKEY = 
"Megam::SshKey".freeze
MEGAM_SSHKEYCOLLECTION = 
"Megam::SshKeyCollection".freeze
MEGAM_SUBSCRIPTIONS = 
"Megam::Subscriptions".freeze
MEGAM_SUBSCRIPTIONSCOLLECTION = 
"Megam::SubscriptionsCollection".freeze
MEGAM_PROMOS = 
"Megam::Promos".freeze

Class Method Summary collapse

Class Method Details

.class_for_json_class(json_class) ⇒ Object

Map JSON_CLAZ to a Class object. We use a case instead of a Hash assigned to a constant because otherwise this file could not be loaded until all the constants were defined, which means you’d have to load the world to get json.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/megam/core/json_compat.rb', line 142

def class_for_json_class(json_class)
  case json_class
  when MEGAM_ERROR
    Megam::Error
  when MEGAM_AUTH
    Megam::Auth
  when MEGAM_ACCOUNT
    Megam::Account
  when MEGAM_ASSEMBLIES
    Megam::Assemblies
  when MEGAM_ASSEMBLIESCOLLECTION
    Megam::AssembliesCollection
  when MEGAM_ASSEMBLY
    Megam::Assembly
  when MEGAM_ASSEMBLYCOLLECTION
    Megam::AssemblyCollection
  when MEGAM_COMPONENTS
    Megam::Components
  when MEGAM_COMPONENTSCOLLECTION
    Megam::ComponentsCollection
  when MEGAM_REQUEST
    Megam::Request
  when MEGAM_REQUESTCOLLECTION
    Megam::RequestCollection
  when MEGAM_SSHKEY
    Megam::SshKey
  when MEGAM_SSHKEYCOLLECTION
    Megam::SshKeyCollection
  when MEGAM_MARKETPLACE
    Megam::MarketPlace
  when MEGAM_MARKETPLACECOLLECTION
    Megam::MarketPlaceCollection
  when MEGAM_MARKETPLACEADDON
    Megam::MarketPlaceAddons
  when MEGAM_MARKETPLACEADDONCOLLECTION
    Megam::MarketPlaceAddonsCollection
  when MEGAM_ORGANIZATION
    Megam::Organizations
  when MEGAM_ORGANIZATIONSCOLLECTION
    Megam::OrganizationsCollection
  when MEGAM_CSAR
    Megam::CSAR
  when MEGAM_CSARCOLLECTION
    Megam::CSARCollection
  when MEGAM_DOMAIN
    Megam::Domains
  when MEGAM_EVENT
    Megam::Event
  when MEGAM_AVAILABLEUNITS
    Megam::Availableunits
  when MEGAM_AVAILABLEUNITSCOLLECTION
    Megam::AvailableunitsCollection
  when MEGAM_BALANCES
    Megam::Balances
  when MEGAM_BALANCESCOLLECTION
    Megam::BalancesCollection
  when MEGAM_BILLEDHISTORIES
    Megam::Billedhistories
  when MEGAM_BILLEDHISTORIESCOLLECTION
    Megam::BilledhistoriesCollection
  when MEGAM_INVOICES
     Megam::Invoices
when MEGAM_INVOICESCOLLECTION
     Megam::InvoicesCollection
  when MEGAM_BILLINGS
    Megam::Billings
  when MEGAM_BILLINGSCOLLECTION
    Megam::BillingsCollection
  when MEGAM_CREDITHISTORIES
    Megam::Credithistories
  when MEGAM_CREDITHISTORIESCOLLECTION
    Megam::CredithistoriesCollection
  when MEGAM_DISCOUNTS
    Megam::Discounts
  when MEGAM_DISCOUNTSCOLLECTION
    Megam::DiscountsCollection
  when MEGAM_SUBSCRIPTIONS
    Megam::Subscriptions
  when MEGAM_SUBSCRIPTIONSCOLLECTION
    Megam::SubscriptionsCollection
  when MEGAM_PROMOS
    Megam::Promos
  else
  raise JSON::ParserError, "Unsupported `json_class` type '#{json_class}'"
  end
end

.from_json(source, opts = {}) ⇒ Object

Just call the JSON gem’s parse method with a modified :max_nesting field



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/megam/core/json_compat.rb', line 81

def from_json(source, opts = {})
  obj = ::Yajl::Parser.parse(source)

  # JSON gem requires top level object to be a Hash or Array (otherwise
  # you get the "must contain two octets" error). Yajl doesn't impose the
  # same limitation. For compatibility, we re-impose this condition.
  unless obj.kind_of?(Hash) or obj.kind_of?(Array)
    raise JSON::ParserError, "Top level JSON object must be a Hash or Array. (actual: #{obj.class})"
  end

  # The old default in the json gem (which we are mimicing because we
  # sadly rely on this misfeature) is to "create additions" i.e., convert
  # JSON objects into ruby objects. Explicit :create_additions => false
  # is required to turn it off.
  if opts[:create_additions].nil? || opts[:create_additions]
    map_to_rb_obj(obj)
  else
  obj
  end
end

.map_hash_to_rb_obj(json_hash) ⇒ Object 



123
124
125
126
127
128
 
# File 'lib/megam/core/json_compat.rb', line 123

def map_hash_to_rb_obj(json_hash)
  json_hash.each do |key, value|
    json_hash[key] = map_to_rb_obj(value)
  end
  json_hash
end

.map_to_rb_obj(json_obj) ⇒ Object

Look at an object that’s a basic type (from json parse) and convert it to an instance of Megam classes if desired.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/megam/core/json_compat.rb', line 104

def map_to_rb_obj(json_obj)

  case json_obj
  when Hash
    mapped_hash = map_hash_to_rb_obj(json_obj)

    if json_obj.has_key?(JSON_CLAZ) && (class_to_inflate = class_for_json_class(json_obj[JSON_CLAZ]))
    class_to_inflate.json_create(mapped_hash)

    else
    mapped_hash
    end
  when Array
    json_obj.map {|e| map_to_rb_obj(e)}
  else
  json_obj
  end
end

.opts_add_max_nesting(opts) ⇒ Object

Increase the max nesting for JSON, which defaults to 19, and isn’t enough for some (for example, a Node within a Node) structures.



72
73
74
75
76
77
78
 
# File 'lib/megam/core/json_compat.rb', line 72

def opts_add_max_nesting(opts)
  if opts.nil? || !opts.has_key?(:max_nesting)
    opts = opts.nil? ? Hash.new : opts.clone
    opts[:max_nesting] = JSON_MAX_NESTING
  end
  opts
end

.to_json(obj, opts = nil) ⇒ Object 



130
131
132
 
# File 'lib/megam/core/json_compat.rb', line 130

def to_json(obj, opts = nil)
  obj.to_json(opts_add_max_nesting(opts))
end

.to_json_pretty(obj, opts = nil) ⇒ Object 



134
135
136
 
# File 'lib/megam/core/json_compat.rb', line 134

def to_json_pretty(obj, opts = nil)
  ::JSON.pretty_generate(obj, opts_add_max_nesting(opts))
end