Class: HaveAPI::Client::Communicator

Inherits:
Object
  • Object
show all
Defined in:
lib/haveapi/client/communicator.rb

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(url, v = nil, verify_ssl: true) ⇒ Communicator

Returns a new instance of Communicator.



21
22
23
24
25
26
27
28
 
# File 'lib/haveapi/client/communicator.rb', line 21

def initialize(url, v = nil, verify_ssl: true)
  @url = url
  @auth = Authentication::NoAuth.new(self, {}, {})
  @rest = RestClient::Resource.new(@url, verify_ssl: verify_ssl)
  @version = v
  @verify_ssl = verify_ssl
  @identity = 'haveapi-client-ruby'
end

Class Attribute Details

.auth_methods ⇒ Object (readonly)

Returns the value of attribute auth_methods.



10
11
12
 
# File 'lib/haveapi/client/communicator.rb', line 10

def auth_methods
  @auth_methods
end

Instance Attribute Details

#auth ⇒ Object (readonly)

Returns the value of attribute auth.



18
19
20
 
# File 'lib/haveapi/client/communicator.rb', line 18

def auth
  @auth
end

#identity ⇒ Object

Returns the value of attribute identity.



19
20
21
 
# File 'lib/haveapi/client/communicator.rb', line 19

def identity
  @identity
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



18
19
20
 
# File 'lib/haveapi/client/communicator.rb', line 18

def url
  @url
end

#verify_ssl ⇒ Object (readonly)

Returns the value of attribute verify_ssl.



18
19
20
 
# File 'lib/haveapi/client/communicator.rb', line 18

def verify_ssl
  @verify_ssl
end

Class Method Details

.register_auth_method(name, klass) ⇒ Object 



12
13
14
15
 
# File 'lib/haveapi/client/communicator.rb', line 12

def register_auth_method(name, klass)
  @auth_methods ||= {}
  @auth_methods[name] = klass
end

Instance Method Details

#auth_save ⇒ Object 



63
64
65
 
# File 'lib/haveapi/client/communicator.rb', line 63

def auth_save
  @auth.save
end

#authenticate(auth_method, options = {}, &block) ⇒ Object

Authenticate user with selected auth_method. auth_method is a name of registered authentication provider. options are specific for each authentication provider.



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/haveapi/client/communicator.rb', line 51

def authenticate(auth_method, options = {}, &block)
  desc = describe_api(@version)

  @auth = self.class.auth_methods[auth_method].new(
    self,
    desc[:authentication][auth_method],
    options,
    &block
  )
  @rest = @auth.resource || @rest
end

#available_versions ⇒ Object 



67
68
69
 
# File 'lib/haveapi/client/communicator.rb', line 67

def available_versions
  description_for(path_for, { describe: :versions })
end

#call(action, params = {}, raw: false) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
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
 
# File 'lib/haveapi/client/communicator.rb', line 120

def call(action, params = {}, raw: false)
  args = []
  input_namespace = action.input && action.namespace(:input)
  meta = nil

  if params.is_a?(Hash) && params[:meta]
    meta = params[:meta]
    params.delete(:meta)
  end

  if %w[POST PUT].include?(action.http_method)
    ns = {}
    ns[input_namespace] = params if input_namespace
    ns[:_meta] = meta if meta
    ns.update(@auth.request_payload)

    args << ns.to_json
    args << { content_type: :json, accept: :json, user_agent: @identity }.update(@auth.request_headers)

  elsif %w[GET DELETE].include?(action.http_method)
    get_params = {}

    params.each do |k, v|
      get_params["#{input_namespace}[#{k}]"] = v
    end

    if meta
      meta.each do |k, v|
        get_params["_meta[#{k}]"] = v # FIXME: read _meta namespace from the description
      end
    end

    args << { params: get_params.update(@auth.request_query_params), accept: :json, user_agent: @identity }.update(@auth.request_headers)
  end

  begin
    response = parse(@rest[action.prepared_path].method(action.http_method.downcase.to_sym).call(*args))
  rescue RestClient::Forbidden
    return error('Access forbidden. Bad user name or password? Not authorized?')
  rescue RestClient::ResourceNotFound,
         RestClient::BadRequest => e
    response = parse(e.http_body)
  rescue StandardError => e
    return error("Fatal API error: #{e.inspect}")
  end

  if response[:status]
    if raw
      ok(JSON.pretty_generate(response[:response]))
    else
      ok(response[:response])
    end

  else
    error(response[:message], response[:errors])
  end
end

#compatible? ⇒ :compatible, ...

Returns:

  • (:compatible) —

    if perfectly compatible

  • (:imperfect) —

    if minor version differs

  • (false) —

    if not compatible



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/haveapi/client/communicator.rb', line 37

def compatible?
  description_for(path_for, { describe: :versions })
  if @proto_version == HaveAPI::Client::PROTOCOL_VERSION
    :compatible
  else
    :imperfect
  end
rescue ProtocolError
  false
end

#describe_action(action) ⇒ Object 



87
88
89
 
# File 'lib/haveapi/client/communicator.rb', line 87

def describe_action(action)
  description_for(action.prepared_help)
end

#describe_api(v = nil) ⇒ Object 



71
72
73
 
# File 'lib/haveapi/client/communicator.rb', line 71

def describe_api(v = nil)
  description_for(path_for(v), v.nil? ? { describe: :default } : {})
end

#describe_resource(path) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/haveapi/client/communicator.rb', line 75

def describe_resource(path)
  tmp = describe_api(@version)

  path.each do |r|
    tmp = tmp[:resources][r.to_sym]

    return false unless tmp
  end

  tmp
end

#get_action(resources, action, args) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/haveapi/client/communicator.rb', line 91

def get_action(resources, action, args)
  tmp = describe_api(@version)

  resources.each do |r|
    tmp = tmp[:resources][r.to_sym]

    return false unless tmp
  end

  a = tmp[:actions][action]

  unless a # search in aliases
    tmp[:actions].each_value do |v|
      if v[:aliases].include?(action.to_s)
        a = v
        break
      end
    end
  end

  if a
    obj = Action.new(nil, self, action, a, args)
    obj.resource_path = resources
    obj
  else
    false
  end
end

#inspect ⇒ Object 



30
31
32
 
# File 'lib/haveapi/client/communicator.rb', line 30

def inspect
  "#<#{self.class.name} @url=#{@url} @version=#{@version} @auth=#{@auth.class.name}>"
end