easypost 1.1.3 → 2.0.0

data/lib/easypost/customs_info.rb

@@ -0,0 +1,4 @@
+module EasyPost
+  class CustomsInfo < Resource
+  end
+end

data/lib/easypost/customs_item.rb

@@ -0,0 +1,4 @@
+module EasyPost
+  class CustomsItem < Resource
+  end
+end

data/lib/easypost/{errors/easypost_error.rb → error.rb}

@@ -1,15 +1,24 @@
 module EasyPost
-  class EasyPostError < StandardError
+  class Error < StandardError
     attr_reader :message
     attr_reader :http_status
     attr_reader :http_body
     attr_reader :json_body
+    attr_reader :param
 
     def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
       @message = message
       @http_status = http_status
       @http_body = http_body
       @json_body = json_body
+
+      begin
+        @param = @json_body[:error][:param]
+      rescue
+        @param = nil
+      end
+
+      super(message)
     end
 
     def to_s

data/lib/easypost/object.rb

@@ -0,0 +1,120 @@
+module EasyPost
+  class EasyPostObject
+    include Enumerable
+
+    attr_accessor :api_key
+    @@immutable_values = Set.new([:api_key, :id])
+
+    def initialize(id=nil, api_key=nil)
+      @api_key = api_key
+      @values = {}
+      @unsaved_values = Set.new
+      @transient_values = Set.new
+      self.id = id if id
+    end
+
+    def self.construct_from(values, api_key=nil)
+      obj = self.new(values[:id], api_key)
+      obj.refresh_from(values, api_key)
+      obj
+    end
+
+    def to_s(*args)
+      MultiJson.dump(@values, :pretty => true)
+    end
+
+    def inspect()
+      id_string = (self.respond_to?(:id) && !self.id.nil?) ? " id=#{self.id}" : ""
+      "#<#{self.class}:#{id_string}> JSON: " + MultiJson.dump(@values, :pretty => true)
+    end
+
+    def refresh_from(values, api_key, partial=false)
+      @api_key = api_key
+
+      added = Set.new(values.keys - @values.keys)
+      
+      instance_eval do
+        add_accessors(added)
+      end
+      
+      values.each do |k, v|
+        @values[k] = Util.convert_to_easypost_object(v, api_key)
+        @transient_values.delete(k)
+        @unsaved_values.delete(k)
+      end
+    end
+
+    def [](k)
+      k = k.to_sym if k.is_a?(String)
+      @values[k]
+    end
+
+    def []=(k, v)
+      send(:"#{k}=", v)
+    end
+
+    def keys
+      @values.keys
+    end
+
+    def values
+      @values.values
+    end
+
+    def to_json(options = {})
+      MultiJson.dump(@values)
+    end
+
+    def as_json(options = {})
+      @values.as_json
+    end
+
+    def to_hash
+      @values
+    end
+
+    def each(&blk)
+      @values.each(&blk)
+    end
+
+    def id=(id)
+      @values[:id] = id
+    end
+
+    def id
+      @values[:id]
+    end
+
+    protected
+
+    def metaclass
+      class << self; self; end
+    end
+
+    def remove_accessors(keys)
+      metaclass.instance_eval do
+        keys.each do |k|
+          next if @@immutable_values.include?(k)
+          k_eq = :"#{k}="
+          remove_method(k) if method_defined?(k)
+          remove_method(k_eq) if method_defined?(k_eq)
+        end
+      end
+    end
+
+    def add_accessors(keys)
+      metaclass.instance_eval do
+        keys.each do |k|
+          next if @@immutable_values.include?(k)
+          k_eq = :"#{k}="
+          define_method(k) { @values[k] }
+          define_method(k_eq) do |v|
+            @values[k] = v
+            @unsaved_values.add(k)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/easypost/parcel.rb

@@ -0,0 +1,4 @@
+module EasyPost
+  class Parcel < Resource
+  end
+end

data/lib/easypost/postage_label.rb

@@ -0,0 +1,4 @@
+module EasyPost
+  class PostageLabel < Resource
+  end
+end

data/lib/easypost/rate.rb

@@ -0,0 +1,4 @@
+module EasyPost
+  class Rate < Resource
+  end
+end

data/lib/easypost/refund.rb

@@ -0,0 +1,4 @@
+module EasyPost
+  class Refund < Resource
+  end
+end

data/lib/easypost/resource.rb

@@ -0,0 +1,67 @@
+module EasyPost
+  class Resource < EasyPostObject
+    def self.class_name
+      camel = self.name.split('::')[-1]
+      snake = camel[0..0] + camel[1..-1].gsub(/([A-Z])/, '_\1')
+      return snake.downcase
+    end
+
+    def self.url
+      if self.class_name == 'resource'
+        raise NotImplementedError.new('Resource is an abstract class.  You should perform actions on its subclasses (Address, Shipment, etc.)')
+      end
+      if(self.class_name[-1..-1] == 's' || self.class_name[-1..-1] == 'h')
+        return "/#{CGI.escape(self.class_name.downcase)}es"
+      else
+        return "/#{CGI.escape(class_name.downcase)}s"
+      end
+    end
+
+    def url
+      unless self.id
+        raise Error.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{self.id.inspect}")
+      end
+      return "#{self.class.url}/#{CGI.escape(id)}"
+    end
+
+    def refresh
+      response, api_key = EasyPost.request(:get, url, @api_key, @retrieve_options)
+      refresh_from(response, api_key)
+      return self
+    end
+
+    def self.all(filters={}, api_key=nil)
+      response, api_key = EasyPost.request(:get, url, api_key, filters)
+      return Util.convert_to_easypost_object(response, api_key)
+    end
+
+    def self.retrieve(id, api_key=nil)
+      instance = self.new(id, api_key)
+      instance.refresh
+      return instance
+    end
+
+    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)
+      return Util.convert_to_easypost_object(response, api_key)
+    end
+
+    def delete
+      response, api_key = EasyPost.request(:delete, url, @api_key)
+      refresh_from(response, api_key)
+      return self
+    end
+
+    def save
+      if @unsaved_values.length > 0
+        values = {}
+        @unsaved_values.each { |k| values[k] = @values[k] }
+        response, api_key = EasyPost.request(:post, url, @api_key, values)
+        refresh_from(response, api_key)
+      end
+      return self
+    end
+  end
+end

data/lib/easypost/scan_form.rb

@@ -0,0 +1,4 @@
+module EasyPost
+  class ScanForm < Resource
+  end
+end

data/lib/easypost/shipment.rb

@@ -0,0 +1,82 @@
+module EasyPost
+  class Shipment < Resource
+
+    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
+
+    def buy(params={})
+      response, api_key = EasyPost.request(:post, url + '/buy', @api_key, params)
+      self.refresh_from(response, @api_key, true)
+
+      return self
+    end
+
+    def refund(params={})
+      response, api_key = EasyPost.request(:get, url + '/refund', @api_key, params)
+      self.refresh_from(response, @api_key, true)
+
+      return self
+    end
+
+    def track(params={})
+      response, api_key = EasyPost.request(:get, url + '/track', @api_key, params)
+      self.refresh_from(response, @api_key, true)
+
+      return self
+    end
+
+    def stamp(params={})
+      response, api_key = EasyPost.request(:get, url + '/stamp', @api_key, params)
+
+      return response[:stamp_url]
+    end
+
+    def barcode(params={})
+      response, api_key = EasyPost.request(:get, url + '/barcode', @api_key, params)
+
+      return response[:barcode_url]
+    end
+
+    def lowest_rate(carriers=[], services=[])
+      lowest = nil
+
+      self.get_rates unless self.rates
+      
+      if !carriers.is_a?(Array)
+        carriers = carriers.split(',')
+      end
+      carriers.map!(&:downcase)
+
+      if !services.is_a?(Array)
+        services = services.split(',')
+      end
+      services.map!(&:downcase)
+
+      self.rates.each do |k|
+
+        rate_carrier = k.carrier.downcase
+        if carriers.size() > 0 && !carriers.include?(rate_carrier)
+          next
+        end
+
+        rate_service = k.service.downcase
+        if services.size() > 0 && !services.include?(rate_service)
+          next
+        end
+
+        if lowest == nil || k.rate.to_f < lowest.rate.to_f          
+            lowest = k
+        end
+      end
+
+      raise Error.new('No rates found.') if lowest == nil
+      
+      return lowest
+    end
+
+  end
+end

data/lib/easypost/util.rb

@@ -0,0 +1,102 @@
+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
+    end
+
+    def self.convert_to_easypost_object(response, api_key)
+      types = { 'Address' => Address,
+        'ScanForm' => ScanForm,
+        'CustomsItem' => CustomsItem,
+        'CustomsInfo' => CustomsInfo,
+        'Parcel' => Parcel,
+        'Shipment' => Shipment,
+        'Rate' => Rate,
+        'Refund' => Refund,
+        'Batch' => Batch,
+        'PostageLabel' => PostageLabel }
+
+      prefixes = { 'adr' => Address,
+        'sf' => ScanForm,
+        'cstitem' => CustomsItem,
+        'cstinfo' => CustomsInfo,
+        'prcl' => Parcel,
+        'shp' => Shipment,
+        'rate' => Rate,
+        'rfnd' => Refund,
+        'batch' => Batch,
+        'pl' => PostageLabel }
+
+      case response
+      when Array
+        return response.map { |i| convert_to_easypost_object(i, api_key) }
+      when Hash
+        if cls_name = response[:object]
+          cls = types[cls_name]
+        elsif response[:id] && cls_prefix = response[:id][0..response[:id].index('_')]
+          cls = prefixes[cls_prefix[0..-2]]
+        end
+      
+        cls ||= EasyPostObject
+        return cls.construct_from(response, api_key)
+      else
+        return response
+      end
+    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.url_encode(key)
+      URI.escape(key.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+
+    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
+        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
+        end
+      end
+      return result
+    end
+  end
+end

data/lib/easypost/version.rb

@@ -0,0 +1,3 @@
+module EasyPost
+  VERSION = "2.0.0"
+end