easypost 3.0.0 → 3.1.5

data/lib/easypost/shipment.rb

@@ -1,124 +1,116 @@
-module EasyPost
-  class Shipment < Resource
+class EasyPost::Shipment < EasyPost::Resource
+  def get_rates(params={})
+    response = EasyPost.make_request(:get, url + '/rates', @api_key, params)
+    self.refresh_from(response, @api_key, true)
 
-    def get_rates(params={})
-      response, api_key = EasyPost.request(:get, url + '/rates', @api_key, params)
-      self.refresh_from(response, @api_key, true)
+    return self
+  end
 
-      return self
+  def buy(params={})
+    if params.instance_of?(EasyPost::Rate)
+      temp = params.clone
+      params = {}
+      params[:rate] = temp
     end
 
-    def buy(params={})
-      if params.instance_of?(EasyPost::Rate)
-        temp = params.clone
-        params = {}
-        params[:rate] = temp
-      end
+    response = EasyPost.make_request(:post, url + '/buy', @api_key, params)
+    self.refresh_from(response, @api_key, true)
 
-      response, api_key = EasyPost.request(:post, url + '/buy', @api_key, params)
-      self.refresh_from(response, @api_key, true)
+    return self
+  end
 
-      return self
+  def insure(params={})
+    if params.is_a?(Integer) || params.is_a?(Float)
+      temp = params.clone
+      params = {}
+      params[:amount] = temp
     end
 
-    def insure(params={})
-      if params.is_a?(Integer) || params.is_a?(Float)
-        temp = params.clone
-        params = {}
-        params[:amount] = temp
-      end
+    response = EasyPost.make_request(:post, url + '/insure', @api_key, params)
+    self.refresh_from(response, @api_key, true)
 
-      response, api_key = EasyPost.request(:post, url + '/insure', @api_key, params)
-      self.refresh_from(response, @api_key, true)
+    return self
+  end
 
-      return self
-    end
+  def refund(params={})
+    response = EasyPost.make_request(:get, url + '/refund', @api_key, params)
+    self.refresh_from(response, @api_key, true)
 
-    def refund(params={})
-      response, api_key = EasyPost.request(:get, url + '/refund', @api_key, params)
-      self.refresh_from(response, @api_key, true)
+    return self
+  end
 
-      return self
+  def print(params={})
+    if params.instance_of?(EasyPost::Printer)
+      return params.print(self.postage_label)
     end
+    return false
+  end
 
-    def print(params={})
-      if params.instance_of?(EasyPost::Printer)
-        return params.print(self.postage_label)
-      end
-      return false
+  def label(params={})
+    if params.is_a?(String)
+      temp = params.clone
+      params = {}
+      params[:file_format] = temp
     end
 
-    def label(params={})
-      if params.is_a?(String)
-        temp = params.clone
-        params = {}
-        params[:file_format] = temp
-      end
-
-      response, api_key = EasyPost.request(:get, url + '/label', @api_key, params)
-      self.refresh_from(response, @api_key, true)
+    response = EasyPost.make_request(:get, url + '/label', @api_key, params)
+    self.refresh_from(response, @api_key, true)
 
-      return self
-    end
+    return self
+  end
 
-    def lowest_rate(carriers=[], services=[])
-      lowest = nil
+  def lowest_rate(carriers=[], services=[])
+    lowest = nil
 
-      self.get_rates unless self.rates
+    self.get_rates unless self.rates
 
-      carriers = carriers.is_a?(String) ? carriers.split(',') : Array(carriers)
-      carriers.map!(&:downcase)
-      carriers.map!(&:strip)
+    carriers = EasyPost::Util.normalize_string_list(carriers)
 
-      negative_carriers = []
-      carriers_copy = carriers.clone
-      carriers_copy.each do |carrier|
-        if carrier[0,1] == '!'
-          negative_carriers << carrier[1..-1]
-          carriers.delete(carrier)
-        end
+    negative_carriers = []
+    carriers_copy = carriers.clone
+    carriers_copy.each do |carrier|
+      if carrier[0,1] == '!'
+        negative_carriers << carrier[1..-1]
+        carriers.delete(carrier)
       end
+    end
 
-      services = services.is_a?(String) ? services.split(',') : Array(services)
-      services.map!(&:downcase)
-      services.map!(&:strip)
-
-      negative_services = []
-      services_copy = services.clone
-      services_copy.each do |service|
-        if service[0,1] == '!'
-          negative_services << service[1..-1]
-          services.delete(service)
-        end
+    services = EasyPost::Util.normalize_string_list(services)
+
+    negative_services = []
+    services_copy = services.clone
+    services_copy.each do |service|
+      if service[0,1] == '!'
+        negative_services << service[1..-1]
+        services.delete(service)
       end
+    end
+
+    self.rates.each do |k|
 
-      self.rates.each do |k|
-
-        rate_carrier = k.carrier.downcase
-        if carriers.size() > 0 && !carriers.include?(rate_carrier)
-          next
-        end
-        if negative_carriers.size() > 0 && negative_carriers.include?(rate_carrier)
-          next
-        end
-
-        rate_service = k.service.downcase
-        if services.size() > 0 && !services.include?(rate_service)
-          next
-        end
-        if negative_services.size() > 0 && negative_services.include?(rate_service)
-          next
-        end
-
-        if lowest == nil || k.rate.to_f < lowest.rate.to_f
-            lowest = k
-        end
+      rate_carrier = k.carrier.downcase
+      if carriers.size() > 0 && !carriers.include?(rate_carrier)
+        next
+      end
+      if negative_carriers.size() > 0 && negative_carriers.include?(rate_carrier)
+        next
       end
 
-      raise Error.new('No rates found.') if lowest == nil
+      rate_service = k.service.downcase
+      if services.size() > 0 && !services.include?(rate_service)
+        next
+      end
+      if negative_services.size() > 0 && negative_services.include?(rate_service)
+        next
+      end
 
-      return lowest
+      if lowest == nil || k.rate.to_f < lowest.rate.to_f
+          lowest = k
+      end
     end
 
+    raise EasyPost::Error.new('No rates found.') if lowest == nil
+
+    return lowest
   end
 end

data/lib/easypost/tracker.rb

@@ -1,15 +1,13 @@
-module EasyPost
-  class Tracker < Resource
-    def self.create_list(params={}, api_key=nil)
-      url = self.url + '/create_list'
-      response, api_key = EasyPost.request(:post, url, api_key, params)
-      return true
-    end
+class EasyPost::Tracker < EasyPost::Resource
+  def self.create_list(params={}, api_key=nil)
+    url = self.url + '/create_list'
+    response = EasyPost.make_request(:post, url, api_key, params)
+    return true
+  end
 
-    def self.all_updated(params={}, api_key=nil)
-      url = self.url + '/all_updated'
-      response, api_key = EasyPost.request(:get, url, api_key, params)
-      return Util.convert_to_easypost_object(response, api_key)
-    end
+  def self.all_updated(params={}, api_key=nil)
+    url = self.url + '/all_updated'
+    response = EasyPost.make_request(:get, url, api_key, params)
+    return EasyPost::Util.convert_to_easypost_object(response, api_key)
   end
 end

data/lib/easypost/user.rb

@@ -1,49 +1,45 @@
-module EasyPost
-  class User < Resource
-    def self.create(params={}, api_key=nil)
-      wrapped_params = {}
-      wrapped_params[self.class_name().to_sym] = params
-      response, api_key = EasyPost.request(:post, self.url, api_key, wrapped_params, {}, false)
-      return Util.convert_to_easypost_object(response, api_key)
-    end
+class EasyPost::User < EasyPost::Resource
+  def self.create(params={}, api_key=nil)
+    response = EasyPost.make_request(:post, self.url, api_key, {self.class_name.to_sym => params})
+    return EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
 
-    def save
-      if @unsaved_values.length > 0
-        values = {}
-        @unsaved_values.each { |k| values[k] = @values[k] }
+  def save
+    if @unsaved_values.length > 0
+      values = {}
+      @unsaved_values.each { |k| values[k] = @values[k] }
 
-        wrapped_params = {user: values}
+      wrapped_params = {user: values}
 
-        response, api_key = EasyPost.request(:put, url, @api_key, wrapped_params)
-        refresh_from(response, api_key)
-      end
-      return self
+      response = EasyPost.make_request(:put, url, @api_key, wrapped_params)
+      refresh_from(response, api_key)
     end
+    return self
+  end
 
-    def self.retrieve_me
-      self.all
-    end
+  def self.retrieve_me
+    self.all
+  end
 
-    def self.all_api_keys
-      response, api_key = EasyPost.request(:get, "/api_keys", @api_key)
-      return Util.convert_to_easypost_object(response, api_key)
-    end
+  def self.all_api_keys
+    response = EasyPost.make_request(:get, "/api_keys", @api_key)
+    return EasyPost::Util.convert_to_easypost_object(response, api_key)
+  end
+
+  def api_keys
+    api_keys = EasyPost::User.all_api_keys
 
-    def api_keys
-      api_keys = EasyPost::User.all_api_keys
-
-      if api_keys.id == self.id
-        my_api_keys = api_keys.keys
-      else
-        for child in api_keys.children
-          if child.id == self.id
-            my_api_keys = child.keys
-            break
-          end
+    if api_keys.id == self.id
+      my_api_keys = api_keys.keys
+    else
+      for child in api_keys.children
+        if child.id == self.id
+          my_api_keys = child.keys
+          break
         end
       end
-
-      my_api_keys
     end
+
+    my_api_keys
   end
 end

data/lib/easypost/util.rb

@@ -1,147 +1,110 @@
-module EasyPost
-  module Util
-    def self.objects_to_ids(obj)
-      case obj
-      when Resource
-        return {:id => obj.id}
-      when Hash
-        result = {}
-        obj.each { |k, v| result[k] = objects_to_ids(v) unless v.nil? }
-        return result
-      when Array
-        return obj.map { |v| objects_to_ids(v) }
-      else
-        return obj
-      end
+module EasyPost::Util
+  def self.objects_to_ids(obj)
+    case obj
+    when EasyPost::Resource
+      return {:id => obj.id}
+    when Hash
+      result = {}
+      obj.each { |k, v| result[k] = objects_to_ids(v) unless v.nil? }
+      return result
+    when Array
+      return obj.map { |v| objects_to_ids(v) }
+    else
+      return obj
     end
+  end
 
-    def self.convert_to_easypost_object(response, api_key, parent=nil, name=nil)
-      types = {
-        'Address' => Address,
-        'ScanForm' => ScanForm,
-        'CustomsItem' => CustomsItem,
-        'CustomsInfo' => CustomsInfo,
-        'Parcel' => Parcel,
-        'Shipment' => Shipment,
-        'Rate' => Rate,
-        'Refund' => Refund,
-        'Event' => Event,
-        'Batch' => Batch,
-        'Tracker' => Tracker,
-        'Item' => Item,
-        'Insurance' => Insurance,
-        'Order' => Order,
-        'Pickup' => Pickup,
-        'PickupRate' => PickupRate,
-        'PostageLabel' => PostageLabel,
-        'Printer' => Printer,
-        'PrintJob' => PrintJob,
-        'CarrierAccount' => CarrierAccount,
-        'User' => User,
-        'Report' => Report,
-        'ShipmentReport' => Report,
-        'PaymentLogReport' => Report,
-        'TrackerReport' => Report,
-        'Webhook' => Webhook
-      }
-
-      prefixes = {
-        'adr' => Address,
-        'sf' => ScanForm,
-        'cstitem' => CustomsItem,
-        'cstinfo' => CustomsInfo,
-        'prcl' => Parcel,
-        'shp' => Shipment,
-        'rate' => Rate,
-        'rfnd' => Refund,
-        'evt' => Event,
-        'batch' => Batch,
-        'trk' => Tracker,
-        'item' => Item,
-        'ins' => Insurance,
-        'order' => Order,
-        'pickup' => Pickup,
-        'pickuprate' => PickupRate,
-        'pl' => PostageLabel,
-        'printer' => Printer,
-        'printjob' => PrintJob,
-        'ca' => CarrierAccount,
-        'user' => User,
-        'shprep' => Report,
-        'plrep' => Report,
-        'trkrep' => Report,
-        'hook' => Webhook
-      }
-
-      case response
-      when Array
-        return response.map { |i| convert_to_easypost_object(i, api_key, parent) }
-      when Hash
-        if cls_name = response[:object]
-          cls = types[cls_name]
-        elsif response[:id]
-          if response[:id].index('_').nil?
-            cls = EasyPostObject
-          elsif cls_prefix = response[:id][0..response[:id].index('_')]
-            cls = prefixes[cls_prefix[0..-2]]
-          end
-        elsif response['id']
-          if response['id'].index('_').nil?
-            cls = EasyPostObject
-          elsif cls_prefix = response['id'][0..response['id'].index('_')]
-            cls = prefixes[cls_prefix[0..-2]]
-          end
-        end
-
-        cls ||= EasyPostObject
-        return cls.construct_from(response, api_key, parent, name)
-      else
-        return response
-      end
-    end
+  def self.normalize_string_list(lst)
+    lst = lst.is_a?(String) ? lst.split(',') : Array(lst)
+    lst.map(&:to_s).map(&:downcase).map(&:strip)
+  end
 
-    def self.symbolize_names(obj)
-      case obj
-      when Hash
-        result = {}
-        obj.each do |k, v|
-          k = (k.to_sym rescue k) || k
-          obj[k] = symbolize_names(v)
-        end
-        return result
-      when Array
-        return obj.map { |v| symbolize_names(v) }
-      else
-        return obj
-      end
-    end
+  def self.convert_to_easypost_object(response, api_key, parent=nil, name=nil)
+    types = {
+      'Address' => EasyPost::Address,
+      'ScanForm' => EasyPost::ScanForm,
+      'CustomsItem' => EasyPost::CustomsItem,
+      'CustomsInfo' => EasyPost::CustomsInfo,
+      'Parcel' => EasyPost::Parcel,
+      'Shipment' => EasyPost::Shipment,
+      'Rate' => EasyPost::Rate,
+      'Refund' => EasyPost::Refund,
+      'Event' => EasyPost::Event,
+      'Batch' => EasyPost::Batch,
+      'Tracker' => EasyPost::Tracker,
+      'Item' => EasyPost::Item,
+      'Insurance' => EasyPost::Insurance,
+      'Order' => EasyPost::Order,
+      'Pickup' => EasyPost::Pickup,
+      'PickupRate' => EasyPost::PickupRate,
+      'PostageLabel' => EasyPost::PostageLabel,
+      'Printer' => EasyPost::Printer,
+      'PrintJob' => EasyPost::PrintJob,
+      'CarrierAccount' => EasyPost::CarrierAccount,
+      'User' => EasyPost::User,
+      'Report' => EasyPost::Report,
+      'ShipmentReport' => EasyPost::Report,
+      'PaymentLogReport' => EasyPost::Report,
+      'TrackerReport' => EasyPost::Report,
+      'RefundReport' => EasyPost::Report,
+      'ShipmentInvoiceReport' => EasyPost::Report,
+      'Webhook' => EasyPost::Webhook
+    }
 
-    def self.url_encode(key)
-      URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
-    end
+    prefixes = {
+      'adr' => EasyPost::Address,
+      'sf' => EasyPost::ScanForm,
+      'cstitem' => EasyPost::CustomsItem,
+      'cstinfo' => EasyPost::CustomsInfo,
+      'prcl' => EasyPost::Parcel,
+      'shp' => EasyPost::Shipment,
+      'rate' => EasyPost::Rate,
+      'rfnd' => EasyPost::Refund,
+      'evt' => EasyPost::Event,
+      'batch' => EasyPost::Batch,
+      'trk' => EasyPost::Tracker,
+      'item' => EasyPost::Item,
+      'ins' => EasyPost::Insurance,
+      'order' => EasyPost::Order,
+      'pickup' => EasyPost::Pickup,
+      'pickuprate' => EasyPost::PickupRate,
+      'pl' => EasyPost::PostageLabel,
+      'printer' => EasyPost::Printer,
+      'printjob' => EasyPost::PrintJob,
+      'ca' => EasyPost::CarrierAccount,
+      'user' => EasyPost::User,
+      'shprep' => EasyPost::Report,
+      'plrep' => EasyPost::Report,
+      'trkrep' => EasyPost::Report,
+      'refrep' => EasyPost::Report,
+      'shpinvrep' => EasyPost::Report,
+      'hook' => EasyPost::Webhook
+    }
 
-    def self.flatten_params(params, parent_key=nil)
-      result = []
-      if params.is_a?(Hash)
-        params.each do |k, v|
-          calculated_key = parent_key ? "#{parent_key}[#{url_encode(k)}]" : url_encode(k)
-          if v.is_a?(Hash) or v.is_a?(Array)
-            result += flatten_params(v, calculated_key)
-          else
-            result << [calculated_key, v]
-          end
+    case response
+    when Array
+      return response.map { |i| convert_to_easypost_object(i, api_key, parent) }
+    when Hash
+      if cls_name = response[:object]
+        cls = types[cls_name]
+      elsif response[:id]
+        if response[:id].index('_').nil?
+          cls = EasyPost::EasyPostObject
+        elsif cls_prefix = response[:id][0..response[:id].index('_')]
+          cls = prefixes[cls_prefix[0..-2]]
         end
-      elsif params.is_a?(Array)
-        params.each_with_index do |v, i|
-          calculated_key = parent_key ? "#{parent_key}[#{i}]" : i
-          if v.is_a?(Hash) or v.is_a?(Array)
-            result += flatten_params(v, calculated_key)
-          else
-            result << [calculated_key, v]
-          end
+      elsif response['id']
+        if response['id'].index('_').nil?
+          cls = EasyPost::EasyPostObject
+        elsif cls_prefix = response['id'][0..response['id'].index('_')]
+          cls = prefixes[cls_prefix[0..-2]]
         end
       end
-      return result
+
+      cls ||= EasyPost::EasyPostObject
+      return cls.construct_from(response, api_key, parent, name)
+    else
+      return response
     end
   end
 end

data/lib/easypost/webhook.rb

@@ -1,28 +1,29 @@
-module EasyPost
-  class Webhook < Resource
-    def update(params={})
-      unless self.id
-        raise Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{self.id.inspect}")
-      end
-      instance_url = "#{self.class.url}/#{CGI.escape(id)}"
-
-      response, api_key = EasyPost.request(:put, instance_url, @api_key, params)
-      self.refresh_from(response, api_key, true)
-
-      return self
+class EasyPost::Webhook < EasyPost::Resource
+  def update(params={})
+    # NOTE: This method is redefined here since the "url" method conflicts
+    # with the objects field
+    unless self.id
+      raise EasyPost::Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{self.id.inspect}")
     end
+    instance_url = "#{self.class.url}/#{CGI.escape(id)}"
 
-    def delete
-      # Note: This method is redefined here since the "url" method conflicts with the objects field
-      unless self.id
-        raise Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{self.id.inspect}")
-      end
-      instance_url = "#{self.class.url}/#{CGI.escape(id)}"
+    response = EasyPost.make_request(:put, instance_url, @api_key, params)
+    self.refresh_from(response, api_key, true)
 
-      response, api_key = EasyPost.request(:delete, instance_url, @api_key)
-      refresh_from(response, api_key)
+    return self
+  end
 
-      return self
+  def delete
+    # NOTE: This method is redefined here since the "url" method conflicts
+    # with the objects field
+    unless self.id
+      raise EasyPost::Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{self.id.inspect}")
     end
+    instance_url = "#{self.class.url}/#{CGI.escape(id)}"
+
+    response = EasyPost.make_request(:delete, instance_url, @api_key)
+    refresh_from(response, api_key)
+
+    return self
   end
 end