Module: Pass

Defined in:
lib/pass.rb,
lib/pass/json.rb,
lib/pass/user.rb,
lib/pass/util.rb,
lib/pass/session.rb,
lib/pass/version.rb,
lib/pass/pass_object.rb,
lib/pass/api_resource.rb,
lib/pass/errors/api_error.rb,
lib/pass/errors/pass_error.rb,
lib/pass/api_operations/create.rb,
lib/pass/errors/api_connection_error.rb,
lib/pass/errors/authentication_error.rb,
lib/pass/errors/invalid_request_error.rb

Defined Under Namespace

Modules: APIOperations, JSON, Util Classes: APIConnectionError, APIError, APIResource, AuthenticationError, InvalidRequestError, PassError, PassObject, Session, User

Constant Summary collapse

VERSION =
'0.1.0'
@@ssl_bundle_path =
File.join(File.dirname(__FILE__), 'data/ca-certificates.crt')
@@api_token =
nil
@@api_base =
'https://api.passauth.net'
@@verify_ssl_certs =
true
@@api_version =
nil

Class Method Summary collapse

Class Method Details

.api_baseObject



52
53
54
# File 'lib/pass.rb', line 52

def self.api_base
  @@api_base
end

.api_base=(api_base) ⇒ Object



48
49
50
# File 'lib/pass.rb', line 48

def self.api_base=(api_base)
  @@api_base = api_base
end

.api_tokenObject



44
45
46
# File 'lib/pass.rb', line 44

def self.api_token
  @@api_token
end

.api_token=(api_token) ⇒ Object



40
41
42
# File 'lib/pass.rb', line 40

def self.api_token=(api_token)
  @@api_token = api_token
end

.api_url(url = '') ⇒ Object



36
37
38
# File 'lib/pass.rb', line 36

def self.api_url(url='')
  @@api_base + url
end

.api_versionObject



68
69
70
# File 'lib/pass.rb', line 68

def self.api_version
  @@api_version
end

.api_version=(version) ⇒ Object



64
65
66
# File 'lib/pass.rb', line 64

def self.api_version=(version)
  @@api_version = version
end

.request(method, url, api_token, params = {}, headers = {}) ⇒ Object



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
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
119
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
177
178
179
180
181
182
# File 'lib/pass.rb', line 72

def self.request(method, url, api_token, params={}, headers={})
  api_token ||= @@api_token
  raise AuthenticationError.new('No API token provided.  (HINT: set your API token using "Pass.api_token = <API-TOKEN>".') unless api_token

  if !verify_ssl_certs
    unless @no_verify
      $stderr.puts "WARNING: Running without SSL cert verification.  Execute 'Pass.verify_ssl_certs = true' to enable verification."
      @no_verify = true
    end
    ssl_opts = { :verify_ssl => false }
  elsif !Util.file_readable(@@ssl_bundle_path)
    unless @no_bundle
      $stderr.puts "WARNING: Running without SSL cert verification because #{@@ssl_bundle_path} isn't readable"
      @no_bundle = true
    end
    ssl_opts = { :verify_ssl => false }
  else
    ssl_opts = {
      :verify_ssl => OpenSSL::SSL::VERIFY_PEER,
      :ssl_ca_file => @@ssl_bundle_path
    }
  end
  uname = (@@uname ||= RUBY_PLATFORM =~ /linux|darwin/i ? `uname -a 2>/dev/null`.strip : nil)
  lang_version = "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})"
  ua = {
    :bindings_version => Pass::VERSION,
    :lang => 'ruby',
    :lang_version => lang_version,
    :platform => RUBY_PLATFORM,
    :publisher => 'pass',
    :uname => uname
  }

  params = Util.objects_to_ids(params)
  url = self.api_url(url)
  case method.to_s.downcase.to_sym
  when :get, :head, :delete
    # Make params into GET parameters
    if params && params.count > 0
      query_string = Util.flatten_params(params).collect{|key, value| "#{key}=#{Util.url_encode(value)}"}.join('&')
      url += "#{URI.parse(url).query ? '&' : '?'}#{query_string}"
    end
    payload = nil
  else
    payload = Util.flatten_params(params).collect{|(key, value)| "#{key}=#{Util.url_encode(value)}"}.join('&')
  end

  begin
    headers = { :x_pass_client_user_agent => Pass::JSON.dump(ua) }.merge(headers)
  rescue => e
    headers = {
      :x_pass_client_raw_user_agent => ua.inspect,
      :error => "#{e} (#{e.class})"
    }.merge(headers)
  end

  headers = {
    :user_agent => "Pass/v1 RubyBindings/#{Pass::VERSION}",
    :authorization => "Token #{api_token}",
    :content_type => 'application/x-www-form-urlencoded',
    :accept => 'application/vnd.pass.v1'
  }.merge(headers)

  if self.api_version
    headers[:pass_version] = self.api_version
  end

  opts = {
    :method => method,
    :url => url,
    :headers => headers,
    :open_timeout => 30,
    :payload => payload,
    :timeout => 80
  }.merge(ssl_opts)

  begin
    response = execute_request(opts)
  rescue SocketError => e
    self.handle_restclient_error(e)
  rescue NoMethodError => e
    # Work around RestClient bug
    if e.message =~ /\WRequestFailed\W/
      e = APIConnectionError.new('Unexpected HTTP response code')
      self.handle_restclient_error(e)
    else
      raise
    end
  rescue RestClient::ExceptionWithResponse => e
    if rcode = e.http_code and rbody = e.http_body
      self.handle_api_error(rcode, rbody)
    else
      self.handle_restclient_error(e)
    end
  rescue RestClient::Exception, Errno::ECONNREFUSED => e
    self.handle_restclient_error(e)
  end

  rbody = response.body
  rcode = response.code
  begin
    # Would use :symbolize_names => true, but apparently there is
    # some library out there that makes symbolize_names not work.
    resp = Pass::JSON.load(rbody)
  rescue MultiJson::DecodeError
    raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
  end

  resp = Util.symbolize_names(resp)
  [resp, api_token]
end

.verify_ssl_certsObject



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

def self.verify_ssl_certs
  @@verify_ssl_certs
end

.verify_ssl_certs=(verify) ⇒ Object



56
57
58
# File 'lib/pass.rb', line 56

def self.verify_ssl_certs=(verify)
  @@verify_ssl_certs = verify
end