Class: Magentwo::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/model/base.rb

Direct Known Subclasses

Cart, Category, Coupon, Customer, Order, Product, SalesRule, StockItem

Constant Summary collapse

DatasetMethods = 
%i(filter exclude select fields count fields info page order_by like gt lt gteq lteq from to)

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ Base

Returns a new instance of Base.



5
6
7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/model/base.rb', line 5

def initialize args
  args.each do |key, value|
    key_sym = :"@#{key}"
    if self.respond_to? :"#{key}="
      instance_variable_set key_sym, value
    end
  end
  if self.respond_to?(:custom_attributes) && args[:custom_attributes]
    self.custom_attributes = args[:custom_attributes].map do |attr|
      Hash[attr[:attribute_code].to_sym, attr[:value]]
    end.inject(&:merge)
  end
end

Class Attribute Details

.adapter ⇒ Object

Returns the value of attribute adapter.



65
66
67
 
# File 'lib/model/base.rb', line 65

def adapter
  @adapter
end

Class Method Details

.[](unique_identifier_value) ⇒ Object 



67
68
69
70
 
# File 'lib/model/base.rb', line 67

def [] unique_identifier_value
  result = Magentwo::Base.get nil, path:"#{base_path}/#{unique_identifier_value}"
  self.new result if result
end

.all(ds = self.dataset, meta_data: false) ⇒ Object 



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

def all ds=self.dataset, meta_data:false
  response = self.get(ds.to_query, :meta_data => meta_data)
  return [] if response.nil?
  items = (meta_data ? response[:items] : response)
  .map do |item|
    self.new item
  end
  if meta_data
    response[:items] = items
    response
  else
    items
  end
end

.base_path ⇒ Object 



81
82
83
 
# File 'lib/model/base.rb', line 81

def base_path
  "#{lower_case_name}s"
end

.call(method, path = self.base_path, params) ⇒ Object 



140
141
142
 
# File 'lib/model/base.rb', line 140

def call method, path=self.base_path, params
  Magentwo::Base.adapter.call(method, path, params)
end

.dataset ⇒ Object 



121
122
123
 
# File 'lib/model/base.rb', line 121

def dataset
  Magentwo::Dataset.new(self)
end

.each(&block) ⇒ Object 



113
114
115
 
# File 'lib/model/base.rb', line 113

def each &block
  self.dataset.each &block
end

.each_page(page_size = Magentwo.default_page_size, &block) ⇒ Object 



109
110
111
 
# File 'lib/model/base.rb', line 109

def each_page page_size=Magentwo.default_page_size, &block
  self.dataset.each_page page_size, &block
end

.first(ds = self.dataset) ⇒ Object 



104
105
106
107
 
# File 'lib/model/base.rb', line 104

def first ds=self.dataset
  response = self.get(ds.page(1, 1).to_query).first
  self.new response if response
end

.get(query, path: self.get_path, meta_data: false) ⇒ Object 



131
132
133
134
135
136
137
138
 
# File 'lib/model/base.rb', line 131

def get query, path:self.get_path, meta_data:false
  case meta_data
  when true then self.call :get_with_meta_data, path, query
  when false then self.call :get, path, query
  else
    raise ArgumentError "unknown meta_data param, expected bool value. got: #{meta_data}"
  end
end

.get_path ⇒ Object 



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

def get_path
  base_path
end

.lower_case_name ⇒ Object 



76
77
78
79
 
# File 'lib/model/base.rb', line 76

def lower_case_name
  name = self.name.split(/::/).last
  "#{name[0,1].downcase}#{name[1..-1]}"
end

.map(&block) ⇒ Object 



117
118
119
 
# File 'lib/model/base.rb', line 117

def map &block
  self.dataset.map &block
end

.unique_identifier ⇒ Object 



72
73
74
 
# File 'lib/model/base.rb', line 72

def unique_identifier
  :id
end

Instance Method Details

#call(method, path, params) ⇒ Object 



39
40
41
 
# File 'lib/model/base.rb', line 39

def call method, path, params
  self.class.call method, path, params
end

#check_presence(*attributes) ⇒ Object 



35
36
37
 
# File 'lib/model/base.rb', line 35

def check_presence *attributes
  Magentwo::Validator.check_presence self, *attributes
end

#delete ⇒ Object 



26
27
28
29
 
# File 'lib/model/base.rb', line 26

def delete
  self.check_presence self.class.unique_identifier
  Magentwo::Base.call :delete, "#{self.class.base_path}/#{self.send(self.class.unique_identifier)}", nil
end

#save ⇒ Object 



19
20
21
22
23
24
 
# File 'lib/model/base.rb', line 19

def save
  self.validate
  self.check_presence self.class.unique_identifier
  response = Magentwo::Base.call :put, "#{self.class.base_path}/#{self.send(self.class.unique_identifier)}", self
  self.class.new response
end

#to_h ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/model/base.rb', line 43

def to_h
  self.instance_variables.map do |k|
    key = k.to_s[1..-1] #symbol to string and remove @ in front
    if key == "custom_attributes"
      [
        key,
        self.send(key).map do |k, v|
          {:attribute_code => k, :value => v}
        end
      ]
    else
      [key, self.send(key)]
    end
  end
  .to_h
end

#to_json ⇒ Object 



60
61
62
 
# File 'lib/model/base.rb', line 60

def to_json
  Hash[self.class.lower_case_name, self.to_h].to_json
end

#validate ⇒ Object 



31
32
33
 
# File 'lib/model/base.rb', line 31

def validate
  true
end