Module: Postmaster

Defined in:
lib/postmaster.rb,
lib/postmaster/json.rb,
lib/postmaster/util.rb,
lib/postmaster/rates.rb,
lib/postmaster/address.rb,
lib/postmaster/package.rb,
lib/postmaster/version.rb,
lib/postmaster/shipment.rb,
lib/postmaster/tracking.rb,
lib/postmaster/api_resource.rb,
lib/postmaster/transit_times.rb,
lib/postmaster/errors/api_error.rb,
lib/postmaster/postmaster_object.rb,
lib/postmaster/api_operations/list.rb,
lib/postmaster/api_operations/create.rb,
lib/postmaster/errors/postmaster_error.rb,
lib/postmaster/errors/api_connection_error.rb,
lib/postmaster/errors/authentication_error.rb,
lib/postmaster/errors/invalid_request_error.rb

Defined Under Namespace

Modules: APIOperations, JSON, Util Classes: APIConnectionError, APIError, APIResource, Address, AddressProposal, AddressValidation, AuthenticationError, InvalidRequestError, Package, PostmasterError, PostmasterObject, Rates, Shipment, Tracking, TrackingHistory, TransitTime, TransitTimes

Constant Summary collapse

VERSION = 
'1.3.0'
@@api_key = 
nil
@@api_base = 
'https://api.postmaster.io'

Class Method Summary collapse

Class Method Details

.api_base ⇒ Object 



61
62
63
 
# File 'lib/postmaster.rb', line 61

def self.api_base
  @@api_base
end

.api_base=(api_base) ⇒ Object 



57
58
59
 
# File 'lib/postmaster.rb', line 57

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

.api_key ⇒ Object 



53
54
55
 
# File 'lib/postmaster.rb', line 53

def self.api_key
  @@api_key
end

.api_key=(api_key) ⇒ Object 



49
50
51
 
# File 'lib/postmaster.rb', line 49

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

.api_url(url = '') ⇒ Object 



45
46
47
 
# File 'lib/postmaster.rb', line 45

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

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

Raises:



65
66
67
68
69
70
71
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
 
# File 'lib/postmaster.rb', line 65

def self.request(method, url, params={}, headers={})
  api_key = self.api_key
  raise AuthenticationError.new('No API key provided.  (HINT: set your API key using "Postmaster.api_key = <API-KEY>".)') unless api_key

  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 => Postmaster::VERSION,
    :lang => 'ruby',
    :lang_version => lang_version,
    :platform => RUBY_PLATFORM,
    :publisher => 'postmaster',
    :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 += "?#{query_string}"
    end
    payload = nil
  else
    if params.kind_of? String
      payload = params
    else
      payload = Util.flatten_params(params).collect{|(key, value)| "#{key}=#{Util.url_encode(value)}"}.join('&')
    end
  end

  begin
    headers = { :x_postmaster_client_user_agent => Postmaster::JSON.dump(ua) }.merge(headers)
  rescue => e
    headers = {
      :x_postmaster_client_raw_user_agent => ua.inspect,
      :error => "#{e} (#{e.class})"
    }.merge(headers)
  end

  headers = {
    :user_agent => "Postmaster/v1 RubyBindings/#{Postmaster::VERSION}",
    :content_type => 'application/x-www-form-urlencoded'
  }.merge(headers)

  opts = {
    :method => method,
    :url => url,
    :headers => headers,
    :open_timeout => 60,
    :payload => payload,
    :timeout => 80,
    :user => api_key,
    :password => "",
  }

  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 = Postmaster::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
end