shippinglogic 1.2.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/CHANGELOG.rdoc

@@ -0,0 +1,55 @@
+== 1.1.3 released 2009-07-17
+
+* Apparently department is not an option, even though FedEx docs say it is and the test services allow it. Production services say its not valid.
+
+== 1.1.2 released 2009-07-17
+
+* Added :department for shipper and recipient options.
+
+== 1.1.1 released 2009-07-17
+
+* Added :just_validate options for creating shipments, that leverages FedExs validation option without creating a shipment.
+* Added more shipper and recipient options, also standardized those options between rating and shipping to create consistency.
+
+== 1.1.0 released 2009-07-16
+
+* Added another layer to tracking. You dont get an array of events anymore, you get a Shippinglogic::Fedex::Track::Details object that has information the single shipment. Such as delivery date, signature name, etc. To access the events you just call the events method on this object.
+* Added speed to rates.
+
+== 1.0.8 released 2009-07-09
+
+* Fix insurance request format.
+
+== 1.0.7 released 2009-07-09
+
+* Fix decimal conversion bug, cant convert a raw float to a decimal.
+
+== 1.0.6 released 2009-07-09
+
+* Reset the cached response if an attribute changes.
+
+== 1.0.5 released 2009-07-08
+
+* Added request to error objects so you can see both the raw request and response.
+
+== 1.0.4 released 2009-07-08
+
+* Added state code mapping so that we can pass full state names and have it convert it to a FedEx friendly code behind the scenes.
+
+== 1.0.3 released 2009-07-08
+
+* Rails uses United States not United State of America
+
+== 1.0.2 released 2009-07-08
+
+* Remove notifications with a successful severity in the errors message.
+* Added country code mapping so that we can pass full country names and have it convert it to a FedEx friendly code behind the scenes.
+
+== 1.0.1 released 2009-07-08
+
+* Fixed delivery deadline option for rate.
+* Ship package dimensions if we arent using our own packaging.
+
+== 1.0.0 released 2009-07-07
+
+* Initial lease

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ben Johnson of Binary Logic
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,175 @@
+= Shippinglogic
+
+== <b>Please note, this library is no longer supported and is being deprecated. A replacement is being worked on that will allow for a seamless transition should use choose to do so.</b>
+
+The goal of this library is to provide simple and straight forward interfaces to the various shipping web services: FedEx, UPS, USPS, etc. (Only FedEx is supported at this time)
+
+== Helpful links
+
+* <b>Documentation:</b> http://rdoc.info/projects/binarylogic/shippinglogic
+* <b>Repository:</b> http://github.com/binarylogic/shippinglogic/tree/master
+* <b>Issues:</b> http://github.com/binarylogic/shippinglogic/issues
+* <b>Google group:</b> http://groups.google.com/group/shippinglogic
+
+<b>Before contacting me directly, please read:</b>
+
+If you find a bug or a problem please post it in the issues section. If you need help with something, please use google groups. I check both regularly and get emails when anything happens, so that is the best place to get help. This also benefits other people in the future with the same questions / problems. Thank you.
+
+== Install & use
+
+Install the gem from rubyforge:
+
+  sudo gem install shippinglogic
+
+Now just include it in your project and you are ready to go.
+
+You can also install this as a plugin:
+
+  script/plugin install git://github.com/binarylogic/shippinglogic.git
+
+See below for usage examples.
+
+== Simple tracking example
+
+What I think is unique about this library is it's usage / syntax:
+
+  fedex = Shippinglogic::FedEx.new(key, password, account, meter)
+  tracking = fedex.track(:tracking_number => "XXXXXXXXXXXXXXXXX")
+  # => A proxy object that delegates calls to an array of Shippinglogic::FedEx::Track::Event objects
+
+  tracking.tracking_number
+  # => "XXXXXXXXXXXXXXXXX"
+
+  tracking.tracking_number = "YYYYYYYYYYYYYYYYYY"
+  # => "YYYYYYYYYYYYYYYYYY"
+
+  tracking.status
+  # => "Delivered"
+
+  tracking.signature_name
+  # => "KKING"
+
+  tracking.events.first
+  # => #<Shippinglogic::FedEx::Track::Event @postal_code="95817", @name="Delivered", @state="CA", @residential=false,
+  #    @city="Sacramento", @type="DL", @country="US", @occured_at=Mon Dec 08 10:43:37 -0500 2008>
+
+  tracking.events.first.name
+  # => "Delivered"
+
+== Calls to the web services are lazy
+
+In our above example, you will notice we are able to access attributes, while at the same time able to treat the object as an array. That's because the object is not actually an array, it acts as a proxy for the underlying array.
+
+That being said, a request is not sent to FedEx until we need to deal with the underlying array. Meaning it's lazy, which is more efficient. Most would think the request to FedEx was sent when we initialized the object. This is not the case. The request to FedEx was sent when we executed "tracking.first".
+
+This is similar to how ActiveRecord's association proxies work. When you call "user.orders" no database activity occurs until you actually use the object (Ex: user.orders.each).
+
+== Flexibility
+
+You will notice above we assign the result of the 'track' method to a variable called 'tracking'. That object has more to it:
+
+  # Initializing
+  tracking = fedex.track(:tracking_number => "XXXXXXXXXXXXX")
+  tracking.tracking_number
+  # => "XXXXXXXXXXXXX"
+
+  # Attribute accessors
+  tracking.tracking_number = "YYYYYYYYYYYYYYY"
+  tracking.tracking_number
+  # => "YYYYYYYYYYYYYYY"
+
+  # Mass attribute setting
+  tracking.attributes = {:tracking_number => "ZZZZZZZZZZZZZZZZ"}
+  tracking.tracking_number
+  # => "ZZZZZZZZZZZZZZZZ"
+
+  tracking.attributes
+  # => {:tracking_number => "ZZZZZZZZZZZZZZZZ"}
+
+== Available services and their features
+
+This library is still very new, as a result only FedEx is supported at this time. More will come.
+
+I spent a lot of time on the documentation, for examples of how to use each service please see the docs for their respective classes.
+
+=== FedEx
+
+1. <b>Tracking</b> - See Shippinglogic::Fedex::Track
+2. <b>Signature proof of delivery</b> - See Shippinglogic::Fedex::Signature
+3. <b>Getting service rates</b> - See Shippinglogic::Fedex::Rate
+4. <b>Creating shipments w/ labels</b> - See Shippinglogic::Fedex::Ship
+5. <b>Canceling shipments</b> - See Shippinglogic::Fedex::Cancel
+
+=== Add your own services
+
+Simply fork the project and make your changes. If you want to add support for a new service it is very straight forward. Checkout the code in Shippinglogic::Fedex::Track, it very simple and easy to follow. It's a great place to start because its the simplest of services.
+
+== Interface integration
+
+What's nice about having an object is that you can pass it around. Let's say you wanted to add simple FedEx tracking functionality to your app:
+
+  class TrackingController < ApplicationController
+    def new
+      @tracking_details = fedex.track(params[:tracking])
+    end
+
+    def create
+      @tracking_details = fedex.track(params[:tracking])
+      render :action => :new if !@tracking.successful?
+    end
+
+    private
+      def fedex
+        @fedex ||= Shippinglogic::FedEx.new(key, password, account, meter)
+      end
+  end
+
+That's pretty simple. Now check out your form:
+
+  # new.html.haml
+  - form_for @tracking_details do |f|
+    = f.error_messages
+    = f.text_field :tracking_number
+    = f.submit "Track"
+
+Then your results:
+
+  # create.html.haml
+  .signature_name= @tracking_details.signature_name
+  - @tracking_details.events.each do |event|
+    .event
+      .name= event.name
+      .occured_at= event.occured_at.to_s(:long)
+      .location== #{event.city}, #{event.state} #{event.postal_code}, #{event.country}
+      .residential= event.residential ? "Yes" : "No"
+
+== Leave abstraction to your application
+
+Here is what I did in an application of mine and it worked out great. I also have complete control of what I'm doing and the library is not limiting me:
+
+  class Shipment < ActiveRecord::Base
+    class Service
+      attr_accessor :carrier, :name, "delivered_by, :rate
+    end
+
+    def services
+      @services ||= fedex_services # + some_other_services
+    end
+
+    private
+      def fedex_services
+        rate_options = {} # replace me with your own options accepted by Shippinglogic::FedEx::Rate
+        fedex.rate(rate_options).collect do |rate|
+          service = Service.new
+          service.carrier = :fedex
+          serivce.name = rate.name
+          service.rate = rate.rate
+          service.delivered_by = rate.delivered_by
+          service
+        end
+      end
+  end
+
+== Copyright
+
+Copyright (c) 2009 {Ben Johnson of Binary Logic}[http://www.binarylogic.com], released under the MIT license

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "shippinglogic"
+    gem.summary = "A simple and clean library to interface with shipping carriers"
+    gem.description = "Easily use FedEx, UPS, USPS web services with an elegant and simple syntax."
+    gem.email = "bjohnson@binarylogic.com"
+    gem.homepage = "http://github.com/binarylogic/shippinglogic"
+    gem.authors = ["Ben Johnson of Binary Logic"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "fakeweb"
+    gem.add_dependency "httparty", ">= 0.4.4"
+    gem.add_dependency "builder", ">= 2.1.2"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec

data/VERSION.yml

@@ -0,0 +1,5 @@
+---
+:major: 1
+:minor: 2
+:patch: 3
+:build: 

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "lib", "shippinglogic")

data/lib/shippinglogic.rb

@@ -0,0 +1,3 @@
+require "shippinglogic/service"
+require "shippinglogic/fedex"
+require "shippinglogic/ups"

data/lib/shippinglogic/attributes.rb

@@ -0,0 +1,121 @@
+module Shippinglogic
+  # Adds in all of the reading / writing for the various serivce options.
+  module Attributes
+    def self.included(klass)
+      klass.class_eval do
+        alias_method(:real_class, :class) unless method_defined? :real_class
+        
+        extend ClassMethods
+        include InstanceMethods
+      end
+    end
+    
+    module ClassMethods
+      # Define an attribute for a class, makes adding options / attributes to the class
+      # much cleaner. See the Rates class for an example.
+      def attribute(name, type, options = {})
+        name = name.to_sym
+        options[:type] = type.to_sym
+        attributes[name] = options
+        
+        define_method(name) { read_attribute(name) }
+        define_method("#{name}=") { |value| write_attribute(name, value) }
+      end
+      
+      # A hash of all the attributes and their options
+      def attributes
+        @attributes ||= {}
+      end
+      
+      # An array of the attribute names
+      def attribute_names
+        attributes.keys
+      end
+      
+      # Returns the options specified when defining a specific attribute
+      def attribute_options(name)
+        attributes[name.to_sym]
+      end
+    end
+    
+    module InstanceMethods
+      # A convenience so that you can set attributes while initializing an object
+      def initialize(*args)
+        attributes = args.last.is_a?(Hash) ? args.last : {}
+        @attributes = {}
+        self.attributes = attributes
+      end
+      
+      # Returns a hash of the various attribute values
+      def attributes
+        attributes = {}
+        attribute_names.each do |name|
+          attributes[name] = send(name)
+        end
+        attributes
+      end
+      
+      # Accepts a hash of attribute values and sets each attribute to those values
+      def attributes=(value)
+        return if value.blank?
+        value.each do |key, value|
+          next if !attribute_names.include?(key.to_sym)
+          send("#{key}=", value)
+        end
+      end
+      
+      private
+        def attribute_names
+          real_class.attribute_names
+        end
+        
+        def attribute_options(name)
+          real_class.attribute_options(name)
+        end
+        
+        def attribute_type(name)
+          attribute_options(name)[:type]
+        end
+        
+        def attribute_default(name)
+          default = attribute_options(name)[:default]
+          case default
+          when Proc
+            default.call(self)
+          else
+            default
+          end
+        end
+        
+        def write_attribute(name, value)
+          @attributes[name.to_sym] = value
+        end
+        
+        def read_attribute(name)
+          name = name.to_sym
+          value = @attributes[name].nil? ? attribute_default(name) : @attributes[name]
+          type = attribute_type(name)
+          return nil if value.nil? && type != :array
+          
+          case type
+          when :array
+            value.is_a?(Array) ? value : [value].compact
+          when :integer
+            value.to_i
+          when :float
+            value.to_f
+          when :decimal
+            BigDecimal.new(value.to_s)
+          when :boolean
+            ["true", "1"].include?(value.to_s)
+          when :string, :text
+            value.to_s
+          when :datetime
+            Time.parse(value.to_s)
+          else
+            value
+          end
+        end
+    end
+  end
+end

data/lib/shippinglogic/error.rb

@@ -0,0 +1,22 @@
+module Shippinglogic
+  class Error < StandardError
+    attr_accessor :errors, :request, :response
+    
+    def initialize(request, response)
+      self.request = request
+      self.response = response
+    end
+    
+    def add_error(error, code = nil)
+      errors << {:message => error, :code => code}
+    end
+    
+    def errors
+      @errors ||= []
+    end
+    
+    def message
+      errors.collect { |e| e[:message] }.join(", ")
+    end
+  end
+end