simple_shipping 0.4.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 69f676b90043220ffa380e7792e4fb651744ed50
+  data.tar.gz: 47469efeb1e360ec1bda3cd31267177145f6821c
+SHA512:
+  metadata.gz: 1d9531870e2266597f74e160954cc9910bfb7a7e6aa44bd76b80b54840263debdf0ae684c0e0346d197a9f8c2263220c97d9aa5339d5828446eebb178cda329f
+  data.tar.gz: aec31ce585327a223c565b1704b0e552d774555327f488c1e836cf3dbe4cf8cdffeaf7ddd725a16d78e145d7d6498342d7577980a4769f872cb289cf3a417d40

data/.document

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

data/.metrics

@@ -0,0 +1,6 @@
+MetricFu::Configuration.run do |config|
+  coverage_file = File.expand_path("coverage/rcov/rcov.txt", Dir.pwd)
+  config.add_metric(:rcov)
+  config.add_graph(:rcov)
+  config.configure_metric(:rcov, {:external => coverage_file})
+end

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format nested
+--backtrace
+--profile

data/.ruby-gemset

@@ -0,0 +1 @@
+simple_shipping

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p429

data/.simplecov

@@ -0,0 +1,43 @@
+require "simplecov-rcov-text"
+require "colorized_text"
+include ColorizedText
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::RcovTextFormatter,
+  SimpleCov::Formatter::HTMLFormatter
+]
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter "/config/"
+
+  # Fail the build when coverage is weak:
+  at_exit do
+    SimpleCov.result.format!
+    threshold, actual = 95.121, SimpleCov.result.covered_percent
+    if actual < threshold
+      msg = "\nLow coverage: "
+      msg << red("#{actual}%")
+      msg << " is #{red 'under'} the threshold: "
+      msg << green("#{threshold}%.")
+      msg << "\n"
+      $stderr.puts msg
+      exit 1
+    else
+      # Precision: three decimal places:
+      actual_trunc = (actual * 1000).floor / 1000.0
+      msg = "\nCoverage: "
+      msg << green("#{actual}%")
+      msg << " is #{green 'over'} the threshold: "
+      if actual_trunc > threshold
+        msg << bold(yellow("#{threshold}%. "))
+        msg << "Please update the threshold to: "
+        msg << bold(green("#{actual_trunc}% "))
+        msg << "in ./.simplecov."
+      else
+        msg << green("#{threshold}%.")
+      end
+      msg << "\n"
+      $stdout.puts msg
+    end
+  end
+end

data/Gemfile

@@ -0,0 +1,26 @@
+source "https://rubygems.org"
+
+gem "activesupport" , "~> 3.1"
+gem "activemodel"   , "~> 3.1"
+gem "savon", "~> 2.2.0"
+
+group :development do
+  gem "rspec",   "~> 2.14.0"
+  gem "yard"
+  gem "bundler"
+  gem "jeweler"
+  gem "json_pure"
+  gem "forgery"
+  gem "rmagick"
+
+  gem "metric_fu"
+end
+
+group :test do
+  gem "webmock"
+  gem "timecop"
+  gem "erubis"
+  gem "equivalent-xml"
+  gem "simplecov",           :require => false
+  gem "simplecov-rcov-text", :require => false
+end

data/Gemfile.lock

@@ -0,0 +1,201 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.16)
+      activesupport (= 3.2.16)
+      builder (~> 3.0.0)
+    activesupport (3.2.16)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.3.5)
+    akami (1.2.0)
+      gyoku (>= 0.4.0)
+      nokogiri (>= 1.4.0)
+    arrayfields (4.9.0)
+    awesome_print (1.2.0)
+    builder (3.0.4)
+    cane (2.6.1)
+      parallel
+    chronic (0.10.2)
+    churn (0.0.35)
+      chronic (>= 0.2.3)
+      hirb
+      json_pure
+      main
+      rest-client (>= 1.6.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.1)
+    code_analyzer (0.4.4)
+      sexp_processor
+    code_metrics (0.1.3)
+    coderay (1.1.0)
+    colored (1.2)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    descendants_tracker (0.0.3)
+    diff-lcs (1.2.5)
+    docile (1.1.2)
+    equivalent-xml (0.4.0)
+      nokogiri (>= 1.4.3)
+    erubis (2.7.0)
+    faraday (0.8.9)
+      multipart-post (~> 1.2.0)
+    fattr (2.2.1)
+    flay (2.4.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.2.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.4)
+    forgery (0.5.0)
+    git (1.2.6)
+    github_api (0.11.1)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    gyoku (1.0.0)
+      builder (>= 2.1.2)
+    hashie (2.0.5)
+    highline (1.6.20)
+    hirb (0.7.1)
+    httpauth (0.2.0)
+    httpi (2.0.2)
+      rack
+    i18n (0.6.9)
+    jeweler (2.0.0)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    json_pure (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    main (5.2.0)
+      arrayfields (>= 4.7.4)
+      chronic (>= 0.6.2)
+      fattr (>= 2.2.0)
+      map (>= 5.1.0)
+    map (6.5.1)
+    metric_fu (4.7.1)
+      cane (~> 2.5, >= 2.5.2)
+      churn (~> 0.0.28)
+      code_metrics (~> 0.1)
+      coderay
+      flay (~> 2.1, >= 2.0.1)
+      flog (~> 4.1, >= 4.1.1)
+      metric_fu-Saikuro (>= 1.1.1.0)
+      multi_json
+      rails_best_practices (~> 1.14, >= 1.14.3)
+      redcard
+      reek (~> 1.3, >= 1.3.4)
+      roodi (~> 3.1)
+    metric_fu-Saikuro (1.1.1.0)
+    mime-types (2.0)
+    mini_portile (0.5.2)
+    multi_json (1.8.3)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    nori (2.1.0)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    parallel (0.9.1)
+    rack (1.5.2)
+    rails_best_practices (1.14.4)
+      activesupport
+      awesome_print
+      code_analyzer (>= 0.4.3)
+      colored
+      erubis
+      i18n
+      require_all
+      ruby-progressbar
+    rake (10.1.1)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    redcard (1.1.0)
+    reek (1.3.6)
+      ruby2ruby (~> 2.0.7)
+      ruby_parser (~> 3.2)
+      sexp_processor
+    require_all (1.3.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rmagick (2.13.2)
+    roodi (3.3.1)
+      ruby_parser (~> 3.2, >= 3.2.2)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    ruby-progressbar (1.4.0)
+    ruby2ruby (2.0.7)
+      ruby_parser (~> 3.1)
+      sexp_processor (~> 4.0)
+    ruby_parser (3.2.2)
+      sexp_processor (~> 4.1)
+    safe_yaml (0.9.7)
+    savon (2.2.0)
+      akami (~> 1.2.0)
+      builder (>= 2.1.2)
+      gyoku (~> 1.0.0)
+      httpi (~> 2.0.2)
+      nokogiri (>= 1.4.0)
+      nori (~> 2.1.0)
+      wasabi (~> 3.1.0)
+    sexp_processor (4.4.1)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    simplecov-rcov-text (0.0.2)
+    timecop (0.7.1)
+    wasabi (3.1.0)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.0)
+    webmock (1.16.1)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel (~> 3.1)
+  activesupport (~> 3.1)
+  bundler
+  equivalent-xml
+  erubis
+  forgery
+  jeweler
+  json_pure
+  metric_fu
+  rmagick
+  rspec (~> 2.14.0)
+  savon (~> 2.2.0)
+  simplecov
+  simplecov-rcov-text
+  timecop
+  webmock
+  yard

data/LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2011 TMX Credit
+Author Potapov, Sergey
+
+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.markdown

@@ -0,0 +1,207 @@
+# Simple Shipping
+
+[![Build Status](https://travis-ci.org/TMXCredit/simple_shipping.png?branch=master)](https://travis-ci.org/TMXCredit/simple_shipping)
+
+Provides a common simple API to build labels for the following shipping services:
+
+* FedEx (http://fedex.com)
+* UPS (http://ups.com) API (https://www.ups.com/upsdeveloperkit)
+
+## Usage
+```ruby
+# Build shipper
+shipper_address = SimpleShipping::Address.new(
+  :country_code => 'US',
+  :state_code   => 'TX',
+  :city         => 'Texas',
+  :street_line  => 'SN2000 Test Meter 8',
+  :postal_code  => '73301'
+)
+shipper_contact = SimpleShipping::Contact.new(
+  :person_name  => 'Mister Someone',
+  :phone_number => '1234567890'
+)
+shipper = SimpleShipping::Party.new(
+  :address => shipper_address,
+  :contact => shipper_contact
+)
+
+# Build recipient
+recipient_address = SimpleShipping::Address.new(
+  :country_code => 'US',
+  :state_code   => 'MN',
+  :city         => 'Minneapolis',
+  :street_line  => 'Nightmare Avenue 13',
+  :postal_code  => '55411'
+)
+recipient_contact = SimpleShipping::Contact.new(
+  :person_name  => "John Recipient Smith",
+  :phone_number => "1234567890"
+)
+recipient = SimpleShipping::Party.new(
+  :address        => recipient_address,
+  :contact        => recipient_contact,
+  # optional, but required if party is payor
+  :account_number => ACCOUNT_NUMBER
+)
+
+package = SimpleShipping::Package.new(
+  :weight          => 1,
+  :length          => 2,
+  :height          => 3,
+  :dimension_units => :in,  # you can use :kg as well
+  :weight_units    => :lb,  # you can use :cm as well
+  :width           => 4,
+  :packaging_type  => :your
+)
+
+# Create clients
+fedex = SimpleShipping::Fedex::Client.new(
+  :credentials => {
+    :key            => KEY,
+    :password       => PASSWORD,
+    :account_number => ACCOUNT_NUMBER,
+    :meter_number   => METER_NUMBER
+})
+ups = SimpleShipping::Ups::ShipClient.new(
+  :credentials => {
+    :username              => USERNAME,
+    :password              => PASSWORD,
+    :access_license_number => ACCESS_LICENSE_NUMBER
+  }
+)
+
+# Do request
+# Default payor is :shipper
+ups_resp   = ups.shipment_request(shipper, recipient, package)
+fedex_resp = fedex.request(shipper, recipient, package, :payor => :recipient)
+```
+
+## Specific extra options
+You can customize the request using specific options for the service by passing an options hash:
+
+### FedEx extra options
+* *:dropoff_type* (see `SimpleShipping::Fedex::ShipmentBuilder::DROPOFF_TYPES` for available values)
+* *:service_type* (see `SimpleShipping::Fedex::ShipmentBuilder::SERVICE_TYPES` for available values)
+
+*Example:*
+```ruby
+fedex_client.request(shipper, recipient, package, :dropoff_type => :drop_box)
+```
+
+## UPS extra options
+* *service_type* (see `SimpleShipping::Ups::ShipmentBuilder::SERVICE_TYPES` for available values)
+
+*Example*
+```ruby
+ups_client.shipment_request(shipper, recipient, package, :service_type => :express)
+```
+
+## Requirements
+
+You must have ImageMagick installed to run the demos.
+
+### Linux
+#### Gentoo
+
+  emerge -pv imagemagick
+  emerge imagemagick
+
+#### Ubuntu
+
+  sudo apt-get install imagemagick libmagic-dev libmagicwand-dev
+
+### OS X
+
+#### Homebrew
+
+  brew install imagemagick
+
+#### MacPorts
+
+  sudo port install imagemagick
+
+#### Fink
+
+  fink install imagemagick
+
+## Developers information
+
+SimpleShipping provides the following models which inherit SimpleShipping::Abstract::Model:
+* Shipment
+* Package
+* Party
+* Address
+* Contact
+
+Every service adapter has its own builders which know how to represent every
+separated model to build SOAP request for a specific service. For example to represent
+Package model, the FedEx adapter has Fedex::PackageBuilder and the UPS adapter has
+Ups::PackageBuilder. All these model builders inherit SimpleShipping::Abstract::Builder.
+
+Request builders are used to build whole request for the service. They inherit
+Abstract::RequestBuilder.
+
+Client is a facade which provides a public API to the user.
+Every service has its own client but they all inherit Abstract::Client.
+All clients provide the same interface:
+* .new(credentials_hash)
+* #request(shipper, recipient, package, opts)
+
+
+## Demo rake tasks
+
+You can test the library against real remote requests.
+For this you need to have a yaml file with your private
+credentials, for example `credentials.yml` wich looks this way:
+
+```yaml
+fedex:
+  key: "KEY"
+  password: "SECRET"
+  account_number: "ACCOUNT NUM"
+  meter_number: "METER NUM"
+
+ups:
+  username: "USER"
+  account_number: "ACCOUNT NUM"
+  password: "SECRET"
+  :access_license_number: "LICENSE NUM"
+```
+
+To run demo tasks:
+```
+rake demo:fedex:shipment_request[credentials.yml]
+rake demo:ups:shipment_request[credentials.yml]
+rake demo:ups:void_request[credentials.yml]
+```
+
+## UPS certification
+
+To run UPS certification:
+
+```
+./script/ups_certification.rb ./credentials.yml
+```
+
+Where `credentials.yml` is file with format described above.
+
+## TODO
+
+* Validation for country codes and states?
+* Refactor
+* Ability to get more information from response object than just a label(tracking number, etc)
+
+## Contributing to simple_shipping
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 TMX Credit. Author Potapov Sergey. See LICENSE.txt for further details.