Class: Clicksign::Resource

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksign/resource.rb

Defined Under Namespace

Classes: QueryProxy

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, &block) ⇒ Object 



240
241
242
243
244
245
246
247
 
# File 'lib/clicksign/resource.rb', line 240

def method_missing(name, *args, &block)
  key = name.to_s.delete_suffix('=')
  if @_attributes&.key?(key)
    name.to_s.end_with?('=') ? @_attributes[key] = args.first : @_attributes[key]
  else
    super
  end
end

Class Attribute Details

.endpoint ⇒ Object 



89
90
91
 
# File 'lib/clicksign/resource.rb', line 89

def endpoint
  @endpoint || "/#{resource_type}"
end

.resource_type ⇒ Object 



85
86
87
 
# File 'lib/clicksign/resource.rb', line 85

def resource_type
  @resource_type || infer_resource_type
end

Instance Attribute Details

#id ⇒ Object (readonly)

Returns the value of attribute id.



206
207
208
 
# File 'lib/clicksign/resource.rb', line 206

def id
  @id
end

#relationships ⇒ Object (readonly)

Returns the value of attribute relationships.



206
207
208
 
# File 'lib/clicksign/resource.rb', line 206

def relationships
  @relationships
end

Class Method Details

.auto_paging_each(&block) ⇒ Object 



151
152
153
154
155
 
# File 'lib/clicksign/resource.rb', line 151

def auto_paging_each(&block)
  return enum_for(:auto_paging_each) unless block_given?

  fetch_auto_pages({}) { |page| page.each(&block) }
end

.client ⇒ Object 



163
164
165
 
# File 'lib/clicksign/resource.rb', line 163

def client
  Thread.current[:clicksign_client] || Clicksign.client
end

.create(**attributes) ⇒ Object 



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

def create(**attributes)
  relationships = attributes.delete(:relationships) || {}
  raw = client.post(
    endpoint,
    body: JsonApi::Serializer.dump(
      type: resource_type, attributes: attributes, relationships: relationships,
    ),
  )
  parsed = JsonApi::Parser.parse(raw)
  build_instance(parsed[:data].first)
end

.each_page(&block) ⇒ Object 



157
158
159
160
161
 
# File 'lib/clicksign/resource.rb', line 157

def each_page(&block)
  return enum_for(:each_page) unless block_given?

  fetch_auto_pages({}, &block)
end

.fields(**types) ⇒ Object 



137
138
139
 
# File 'lib/clicksign/resource.rb', line 137

def fields(**types)
  QueryProxy.new(self, JsonApi::QueryBuilder.new.fields(**types))
end

.filter(**params) ⇒ Object 



117
118
119
 
# File 'lib/clicksign/resource.rb', line 117

def filter(**params)
  QueryProxy.new(self, JsonApi::QueryBuilder.new.filter(**params))
end

.filter_params(**filters) ⇒ Object 



147
148
149
 
# File 'lib/clicksign/resource.rb', line 147

def filter_params(**filters)
  filters.empty? ? {} : JsonApi::QueryBuilder.new.filter(**filters).to_params
end

.include(*types) ⇒ Object 



121
122
123
 
# File 'lib/clicksign/resource.rb', line 121

def include(*types)
  QueryProxy.new(self, JsonApi::QueryBuilder.new.include(*types))
end

.list(**filters) ⇒ Object 



93
94
95
96
97
 
# File 'lib/clicksign/resource.rb', line 93

def list(**filters)
  return fetch_list({}) if filters.empty?

  filter(**filters).to_a
end

.nested_list(parent_id, nested_type:, as: self, params: {}) ⇒ Object 



141
142
143
144
145
 
# File 'lib/clicksign/resource.rb', line 141

def nested_list(parent_id, nested_type:, as: self, params: {})
  raw    = client.get("#{endpoint}/#{parent_id}/#{nested_type}", params: params)
  parsed = JsonApi::Parser.parse(raw)
  parsed[:data].map { |item| as.send(:build_instance, item, parent_id: parent_id) }
end

.order(field) ⇒ Object 



125
126
127
 
# File 'lib/clicksign/resource.rb', line 125

def order(field)
  QueryProxy.new(self, JsonApi::QueryBuilder.new.order(field))
end

.page(number) ⇒ Object 



129
130
131
 
# File 'lib/clicksign/resource.rb', line 129

def page(number)
  QueryProxy.new(self, JsonApi::QueryBuilder.new.page(number))
end

.per(size) ⇒ Object 



133
134
135
 
# File 'lib/clicksign/resource.rb', line 133

def per(size)
  QueryProxy.new(self, JsonApi::QueryBuilder.new.per(size))
end

.retrieve(id) ⇒ Object 



99
100
101
102
103
 
# File 'lib/clicksign/resource.rb', line 99

def retrieve(id)
  raw    = client.get("#{endpoint}/#{id}")
  parsed = JsonApi::Parser.parse(raw)
  build_instance(parsed[:data].first)
end

Instance Method Details

#[](key) ⇒ Object 



236
237
238
 
# File 'lib/clicksign/resource.rb', line 236

def [](key)
  @_attributes&.[](key.to_s)
end

#base_path ⇒ Object 



232
233
234
 
# File 'lib/clicksign/resource.rb', line 232

def base_path
  self.class.endpoint
end

#delete ⇒ Object 



220
221
222
223
 
# File 'lib/clicksign/resource.rb', line 220

def delete
  self.class.client.delete("#{base_path}/#{@id}")
  nil
end

#reload ⇒ Object 



225
226
227
228
229
230
 
# File 'lib/clicksign/resource.rb', line 225

def reload
  raw    = self.class.client.get("#{base_path}/#{@id}")
  parsed = JsonApi::Parser.parse(raw)
  load_data(parsed[:data].first, parent_id: @_parent_id)
  self
end

#respond_to_missing?(name, include_private = false) ⇒ Boolean

Returns:

  • (Boolean) 


249
250
251
252
 
# File 'lib/clicksign/resource.rb', line 249

def respond_to_missing?(name, include_private = false)
  key = name.to_s.delete_suffix('=')
  @_attributes&.key?(key) || super
end

#update(**attributes) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/clicksign/resource.rb', line 208

def update(**attributes)
  raw = self.class.client.patch(
    "#{base_path}/#{@id}",
    body: JsonApi::Serializer.dump(
      type: self.class.resource_type, id: @id, attributes: attributes,
    ),
  )
  parsed = JsonApi::Parser.parse(raw)
  load_data(parsed[:data].first, parent_id: @_parent_id)
  self
end